# Spondyr

Spondyr is a correspondence template management and distribution platform that enables developers to quickly integrate template-driven content delivery via API, supporting email, SMS, fax, and postal mail.

- **Category:** documents
- **Auth:** API_KEY
- **Tools:** 21
- **Triggers:** 0
- **Slug:** `SPONDYR`
- **Version:** 20260211_00

## Tools

### List Conditions

**Slug:** `SPONDYR_CONDITIONS_LIST`

Tool to list all conditions for a transaction type. Use when you need to discover existing condition rules before creating templates or generating correspondence. Conditions define criteria for selecting specific templates based on transaction data.

### Create Condition

**Slug:** `SPONDYR_CREATE_CONDITION`

Create a condition rule for template selection in Spondyr. Conditions define matching criteria on transaction data fields that determine which document template to use. For example, create a condition on an 'OrderStatus' field to trigger different email templates for 'Pending' vs 'Shipped' orders.

### Create Transaction Type

**Slug:** `SPONDYR_CREATE_TRANSACTION_TYPE`

Tool to create a new transaction type. Use after defining the JSON schema for your data to register it in Spondyr.

### Deliver Spondyr correspondence

**Slug:** `SPONDYR_DELIVER_SPONDYR`

Trigger delivery of previously generated correspondence to recipients. Use this action after generating correspondence (via POST /Spondyr with IsGenerateOnly=true) to actually deliver the documents via email, fax, mail, or text message. The ReferenceID from the generate request is required to identify which correspondence to deliver.

### Update Event Type

**Slug:** `SPONDYR_EVENT_TYPE_UPDATE`

Tool to update an existing event type name within a transaction type. Use when you need to rename an Event Type. Example: Rename the 'OrderShipped' event to 'OrderDelivered' within the 'CustomerOrders' transaction type. Note: This only changes the event type's name - it does not move the event to a different transaction type.

### List Event Types for Transaction Type

**Slug:** `SPONDYR_GET_EVENT_TYPES`

Retrieves all event types associated with a specific transaction type in Spondyr. Event types define the kinds of events that can occur for a transaction type (e.g., "Created", "Updated", "Cancelled" events for an "Order" transaction type). Use this action after retrieving transaction types to discover what event types are available for a given transaction type. This is essential for understanding the event-driven workflows and setting up event-based automation in Spondyr. Returns an empty list if the transaction type exists but has no event types configured.

### Get Spondyr Status

**Slug:** `SPONDYR_GET_SPONDYR_STATUS`

Tool to retrieve the status of a previously generated correspondence. Use after generating correspondence to check its processing and delivery status.

### Get Transaction Types

**Slug:** `SPONDYR_GET_TRANSACTION_TYPES`

Tool to retrieve a list of available transaction types. Use after authentication to discover data schemas.

### Delete Recipient

**Slug:** `SPONDYR_RECIPIENT_DELETE`

Deletes a recipient configuration from a transaction type in Spondyr. Recipients are configured delivery endpoints (email addresses, fax numbers, physical addresses) that determine where correspondence will be sent when a transaction is processed. This action permanently removes a recipient configuration from the specified transaction type. Before deletion, use the 'List Recipients' action to verify the recipient name and transaction type. After successful deletion, the recipient will no longer be available for correspondence delivery.

### Get Recipient

**Slug:** `SPONDYR_RECIPIENT_GET`

Tool to retrieve details of a specific recipient. Use when you need to fetch recipient configuration for a given transaction type. Example: "Retrieve recipient 'Customer' for transaction type 'OrderPlaced'."

### List Recipients

**Slug:** `SPONDYR_RECIPIENTS_LIST`

Tool to list all recipients for a transaction type. Use when you need to discover or verify all configured recipients before sending or managing correspondence.

### Create Search Filter

**Slug:** `SPONDYR_SEARCH_FILTER_CREATE`

Create a new search filter for a transaction type in Spondyr. Search filters enable you to define searchable fields within your transaction data. Once created, these filters allow you to quickly search and retrieve specific transactions based on field values (e.g., search by OrderID, CustomerName, InvoiceNumber). Use this tool when you need to make a specific field searchable within a transaction type.

### Delete Search Filter

**Slug:** `SPONDYR_SEARCH_FILTER_DELETE`

Deletes a specific search filter from the Spondyr system. Use this when you need to remove a search filter that is no longer needed. Both the filter name and transaction type must exactly match the values used when the filter was created. If the filter does not exist, the API will return an error.

### Get Search Filter

**Slug:** `SPONDYR_SEARCH_FILTER_GET`

Retrieves details of a specific search filter in Spondyr by name and transaction type. Returns the filter's name, tag value, and associated transaction type. Use this when you need to look up an existing search filter's configuration, verify its tag format, or confirm which transaction type it belongs to before using it for correspondence searches.

### List Search Filters

**Slug:** `SPONDYR_SEARCH_FILTERS_LIST`

Tool to list all search filters for a transaction type. Use when you need to discover available filters before searching correspondence.

### Search Correspondence

**Slug:** `SPONDYR_SEARCH_SPONDYRS`

Search for generated correspondence (spondyrs) by multiple criteria including batch ID, event type, and custom search filters. Returns paginated results with delivery status, recipient information, and URIs to access generated documents. Use this to find and retrieve previously generated correspondence.

### Create Spondyr SSO stub

**Slug:** `SPONDYR_SSO_STUB`

Tool to create a one-time SSO user stub in Spondyr. Use after application authentication to generate a temporary SSO token for embedding or redirecting users.

### Get Template

**Slug:** `SPONDYR_TEMPLATE_GET`

Retrieve detailed configuration for a specific correspondence template. Returns template content reference ID, event type, recipients, delivery methods, conditions, and search filters. Use this action when you need to: - Inspect template settings and configuration - View recipient delivery methods (Email, Mail, Text, DocuSign, Fax, Destination) - Review template selection conditions and search filters - Get the template content reference ID for correspondence generation Prerequisites: Use 'Get Transaction Types' to discover transaction types, then 'List Templates' to find available template names. Example: Retrieve template 'OrderConfirmationEmail' for transaction type 'CustomerOrder'.

### List Templates

**Slug:** `SPONDYR_TEMPLATES_LIST`

List all templates configured for a transaction type. Use this to discover available templates before generating correspondence or to audit template configurations. Returns template metadata including name, event type, content type, recipients, conditions, and search filters. Use Get Template action to retrieve full template content and detailed configuration.

### Get Transaction Type

**Slug:** `SPONDYR_TRANSACTION_TYPE_GET`

Tool to retrieve details of a specific transaction type. Use when inspecting a transaction type schema. Returns the schema definition including JSON structure and CSV field mappings. Example: "Get transaction type 'CustomerOrder' to view its JSON schema and available fields."

### Update Transaction Type

**Slug:** `SPONDYR_TRANSACTION_TYPE_UPDATE`

Updates an existing transaction type's name and/or JSON schema in Spondyr. Use this tool to: - Modify the JSON schema/template of a transaction type to add, remove, or change data fields - Rename an existing transaction type - Update sample data values in the template Prerequisites: The transaction type must already exist. Use 'Get Transaction Types' to list available types or 'Get Transaction Type' to retrieve the current schema before updating. Example: Update the 'OrderPlaced' transaction type with a new JSON schema that includes customer address fields.
