Spondyr

Learn how to use Spondyr with Composio

Overview

SLUG

SPONDYR

Description

Template description for spondyr

Authentication Details

generic_api_key
stringRequired

Tools

SLUG: SPONDYR_CONDITIONS_LIST

Tool to list all conditions for a transaction type. use when you need to retrieve all condition rules defined for a specific transaction type.

Action Parameters

TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_CREATE_CONDITION

Tool to create a new condition. use when defining detailed rules for template selection based on transaction data.

Action Parameters

FieldName
stringRequired
Name
stringRequired
PossibleValues
string
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

Name
stringRequired
TemplateJSON
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_DELIVER_SPONDYR

Tool to trigger delivery of a previously generated correspondence. use after calling the generate api.

Action Parameters

NewRecipients
array
OriginalRecipients
stringDefaults to All
ReferenceID
stringRequired
Template
stringDefaults to All

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_EVENT_TYPE_UPDATE

Tool to update an existing event type. use when you need to modify the name or associated transaction type of an event type. example: rename the 'ordershipped' event to 'orderdelivered'.

Action Parameters

EventType
stringRequired
Name
stringRequired
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_GET_EVENT_TYPES

Tool to list all event types for a given transaction type. use when you need to discover available events after retrieving transaction types.

Action Parameters

TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

ApplicationUserID
string
FirstName
string
IncludeData
boolean
LastName
string
ReferenceID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_GET_TRANSACTION_TYPES

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_RECIPIENT_DELETE

Tool to delete or deactivate a specific recipient. use when you need to remove an existing recipient mapping in spondyr.

Action Parameters

Recipient
stringRequired
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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

Action Parameters

Recipient
stringRequired
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_SEARCH_FILTER_CREATE

Tool to create a new search filter. use when you need to define a reusable filter for a specific transaction type.

Action Parameters

Name
stringRequired
Tag
stringRequired
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_SEARCH_FILTER_DELETE

Tool to delete or deactivate a specific search filter. use when you need to remove an existing search filter by name. call after confirming the filter exists.

Action Parameters

Search
stringRequired
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_SEARCH_FILTER_GET

Tool to retrieve details of a specific search filter. use when you need to fetch the tag and transaction type of an existing filter by name.

Action Parameters

Search
stringRequired
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_SEARCH_SPONDYRS

Tool to search generated correspondence by multiple criteria. use after correspondence generation to retrieve historical records with filters, paging, and sorting.

Action Parameters

BatchReferenceID
string
EventType
string
Page
integer
PageSize
integer
SearchName
string
SearchValue
string
SortColumn
string
SortOrder
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

ApplicationUserID
stringRequired
FirstName
stringRequired
LastName
stringRequired
Role
stringRequired
TenantToken
string
TimeZone
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_TEMPLATES_LIST

Tool to list all templates for a transaction type. use when you need to discover available templates before generating correspondence.

Action Parameters

TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_TEMPLATE_GET

Tool to retrieve a specific template’s configuration and content reference. use when you need to inspect a template's settings for a transaction type. example: "fetch template 'mytemplate' for transaction type 'orderplaced'."

Action Parameters

Template
stringRequired
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_TRANSACTION_TYPE_GET

Tool to retrieve details of a specific transaction type. use when inspecting a transaction type schema. example: "get transaction type 'orderplaced' to view its json schema."

Action Parameters

TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SPONDYR_TRANSACTION_TYPE_UPDATE

Tool to update an existing transaction type. use after retrieving a transaction type to apply changes. example: "update transaction type 'order' with new json schema."

Action Parameters

Name
stringRequired
TemplateJSON
stringRequired
TransactionType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired