# 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
- **Composio Managed App Available?** N/A
- **Tools:** 21
- **Triggers:** 0
- **Slug:** `SPONDYR`
- **Version:** 20260227_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `TransactionType` | string | Yes | The name of the Transaction Type whose conditions are to be listed. Use the Get Transaction Types action first to discover available transaction types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | A unique name identifier for this condition rule. Used to reference this condition when configuring template selection logic. |
| `FieldName` | string | Yes | The data field from the transaction to evaluate. For nested fields, use underscore notation (e.g., 'Address_City'). Must exist in the transaction type's schema. |
| `PossibleValues` | string | No | Optional list of allowed values for this field, separated by newlines. If provided, the condition will match only when the field value is in this list. Omit to allow any value. |
| `TransactionType` | string | Yes | The name of an existing Transaction Type to create this condition rule for. Must match a Transaction Type previously created in the system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | The name of the Transaction Type to create |
| `TemplateJSON` | string | Yes | JSON-formatted string containing sample data defining the transaction schema |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Template` | string | No | Templates to deliver; 'All' or comma-delimited list. Defaults to 'All'. |
| `ReferenceID` | string | Yes | The unique reference ID returned from the original generate request (POST /Spondyr). Used to identify which correspondence to deliver. |
| `NewRecipients` | array | No | Additional recipients beyond the originally configured list. |
| `OriginalRecipients` | string | No | Original recipients to deliver; 'All', 'None', or comma-delimited list. Defaults to 'All'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | The new name for the Event Type. |
| `EventType` | string | Yes | The name of the existing Event Type to update. |
| `TransactionType` | string | Yes | The Transaction Type name this Event Type belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `TransactionType` | string | Yes | The exact name of the Transaction Type whose event types are to be listed. Must match an existing transaction type name (case-sensitive). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `LastName` | string | No | Optional viewer last name for logging |
| `FirstName` | string | No | Optional viewer first name for logging |
| `IncludeData` | boolean | No | Include original data payload in the response if true |
| `ReferenceID` | string | Yes | Reference ID returned from the Send/Generate request |
| `ApplicationUserID` | string | No | Optional user identifier for viewer context logging |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transaction Types

**Slug:** `SPONDYR_GET_TRANSACTION_TYPES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Recipient` | string | Yes | The name of the recipient to delete. This is the 'Name' field that was used when the recipient was created. Use the 'List Recipients' action with the transaction type to find all configured recipient names. |
| `TransactionType` | string | Yes | The name of the Transaction Type that the recipient belongs to. Must match an existing transaction type in your Spondyr account. Use the 'Get Transaction Types' action to list all available transaction types, or 'List Recipients' to see which transaction types have configured recipients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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'."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Recipient` | string | Yes | The name of the Recipient to retrieve. |
| `TransactionType` | string | Yes | The name of the Transaction Type this Recipient is for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `TransactionType` | string | Yes | The name of the Transaction Type whose recipients are to be listed. Use the Get Transaction Types action to retrieve available transaction type names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Tag` | string | Yes | The tag template defining which field from the transaction data to filter by. Use curly braces to wrap field names (e.g., {FieldName}). For nested fields, use underscore notation (e.g., {Vendor_Name}). |
| `Name` | string | Yes | The name/identifier for this search filter. This will be used to reference the filter and is returned as ReferenceID in the response. |
| `TransactionType` | string | Yes | The name of the Transaction Type this search filter belongs to. Must be an existing transaction type name (use Get Transaction Types to retrieve available types). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Search` | string | Yes | The name of the Search Filter to delete. Must exactly match the 'Name' field used when the filter was created. |
| `TransactionType` | string | Yes | The Transaction Type that the Search Filter belongs to. Must exactly match the 'TransactionType' the filter was created with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Search` | string | Yes | The name of the Search Filter to retrieve (case-sensitive). |
| `TransactionType` | string | Yes | The name of the Transaction Type that the Search Filter belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `TransactionType` | string | Yes | The name of the Transaction Type whose search filters are to be listed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Page` | integer | No | Page number for pagination (1-based). |
| `PageSize` | integer | No | Number of records per page (max 250). |
| `EventType` | string | No | Filter results to correspondence generated for a specific event type (e.g., 'NewOrder', 'Invoice', 'Receipt'). |
| `SortOrder` | string ("ASC" | "DESC") | No | Sort direction: ASC or DESC. |
| `SearchName` | string | No | Name of a custom search filter/tag to apply (e.g., 'OrderNumber', 'CustomerID'). Use with SearchValue to filter by custom metadata. |
| `SortColumn` | string | No | Field name to sort results by (e.g., 'CreatedDate', 'ReferenceID'). Defaults to 'CreatedDate' if not specified. |
| `SearchValue` | string | No | Value to match for the custom search filter specified in SearchName. Must be used together with SearchName. |
| `BatchReferenceID` | string | No | Filter results to a specific batch reference ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Role` | string ("Owner" | "Integrator" | "Editor" | "Tenant User") | Yes | Stub user's permissions. One of: Owner, Integrator, Editor, Tenant User. |
| `LastName` | string | Yes | SSO user's last name (URL-encoded). |
| `TimeZone` | string | No | Display timezone (IANA/Windows name). Defaults to UTC if omitted or invalid. |
| `FirstName` | string | Yes | SSO user's first name (URL-encoded). |
| `TenantToken` | string | No | Tenant token for multi-tenant applications. |
| `ApplicationUserID` | string | Yes | Your system's user identifier for the SSO user (URL-encoded). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Template` | string | Yes | The name of the template to retrieve. Use the 'List Templates' action first to discover available template names for the transaction type. |
| `TransactionType` | string | Yes | The name of the Transaction Type this template belongs to. Use the 'Get Transaction Types' action to discover available transaction types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `TransactionType` | string | Yes | The name of the Transaction Type whose templates are to be listed. Use the Get Transaction Types action first to discover available transaction types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `TransactionType` | string | Yes | The name of the Transaction Type to retrieve. API is case-insensitive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | The new or updated name for the transaction type. Use the same value as TransactionType to keep the name unchanged, or provide a different value to rename it. |
| `TemplateJSON` | string | Yes | A valid JSON-formatted string defining the transaction schema with all available properties and sample data. This defines what data fields are available for correspondence templates. |
| `TransactionType` | string | Yes | The name of the existing transaction type to update. This identifies which transaction type to modify. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |