NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Spondyr

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.

DocumentsEmailWeb del proveedor
Acciones
21
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (21)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

List ConditionsSPONDYR_CONDITIONS_LISTAcción

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

Parámetros de entrada

  • TransactionTypestringObligatorio

    Name of the transaction type to list all conditions for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ConditionSPONDYR_CREATE_CONDITIONAcción

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

Parámetros de entrada

  • NamestringObligatorio

    The name of the new Condition.

  • FieldNamestringObligatorio

    The field name from the transaction type JSON/CSV to apply this condition to.

  • PossibleValuesstring

    Optional newline-delimited values to match (use ' ' or ' ' between values).

  • TransactionTypestringObligatorio

    The name of the Transaction Type this Condition is for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Transaction TypeSPONDYR_CREATE_TRANSACTION_TYPEAcción

Tool to create a new transaction type. use after defining the json schema for your data to register it in spondyr.

Parámetros de entrada

  • NamestringObligatorio

    The name of the Transaction Type to create

  • TemplateJSONstringObligatorio

    JSON-formatted string containing sample data defining the transaction schema

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Deliver Spondyr correspondenceSPONDYR_DELIVER_SPONDYRAcción

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

Parámetros de entrada

  • Templatestring

    Templates to deliver; 'All' or comma-delimited list. Defaults to 'All'.

  • ReferenceIDstringObligatorio

    The reference ID from the original generate request.

  • NewRecipientsobject[]

    Additional recipients beyond the originally configured list.

  • OriginalRecipientsstring

    Original recipients to deliver; 'All', 'None', or comma-delimited list. Defaults to 'All'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Event TypeSPONDYR_EVENT_TYPE_UPDATEAcción

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

Parámetros de entrada

  • NamestringObligatorio

    The new name for the Event Type.

  • EventTypestringObligatorio

    The name of the existing Event Type to update.

  • TransactionTypestringObligatorio

    The Transaction Type name this Event Type belongs to.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Event TypesSPONDYR_GET_EVENT_TYPESAcción

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

Parámetros de entrada

  • TransactionTypestringObligatorio

    The name of the Transaction Type whose event types are to be listed

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Spondyr StatusSPONDYR_GET_SPONDYR_STATUSAcción

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

Parámetros de entrada

  • LastNamestring

    Optional viewer last name for logging

  • FirstNamestring

    Optional viewer first name for logging

  • IncludeDataboolean

    Include original data payload in the response if true

  • ReferenceIDstringObligatorio

    Reference ID returned from the Send/Generate request

  • ApplicationUserIDstring

    Optional user identifier for viewer context logging

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Transaction TypesSPONDYR_GET_TRANSACTION_TYPESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete RecipientSPONDYR_RECIPIENT_DELETEAcción

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

Parámetros de entrada

  • RecipientstringObligatorio

    The name of the Recipient to delete or deactivate.

  • TransactionTypestringObligatorio

    The name of the Transaction Type this Recipient is for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get RecipientSPONDYR_RECIPIENT_GETAcción

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

Parámetros de entrada

  • RecipientstringObligatorio

    The name of the Recipient to retrieve.

  • TransactionTypestringObligatorio

    The name of the Transaction Type this Recipient is for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List RecipientsSPONDYR_RECIPIENTS_LISTAcción

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.

Parámetros de entrada

  • TransactionTypestringObligatorio

    The name of the Transaction Type whose recipients are to be listed

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Search FilterSPONDYR_SEARCH_FILTER_CREATEAcción

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

Parámetros de entrada

  • TagstringObligatorio

    The tag value to assign for this search filter (e.g. {OrderNumber}).

  • NamestringObligatorio

    The name of the new search filter.

  • TransactionTypestringObligatorio

    The name of the Transaction Type this Search Filter is for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Search FilterSPONDYR_SEARCH_FILTER_DELETEAcción

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.

Parámetros de entrada

  • SearchstringObligatorio

    The name of the Search Filter to delete.

  • TransactionTypestringObligatorio

    The Transaction Type of the Search Filter.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Search FilterSPONDYR_SEARCH_FILTER_GETAcción

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.

Parámetros de entrada

  • SearchstringObligatorio

    The name of the Search Filter to retrieve.

  • TransactionTypestringObligatorio

    The Transaction Type of the Search Filter.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Search FiltersSPONDYR_SEARCH_FILTERS_LISTAcción

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

Parámetros de entrada

  • TransactionTypestringObligatorio

    The name of the Transaction Type whose search filters are to be listed

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search CorrespondenceSPONDYR_SEARCH_SPONDYRSAcción

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

Parámetros de entrada

  • Pageinteger

    Page number for pagination (1-based).

  • PageSizeinteger

    Number of records per page (max 250).

  • EventTypestring

    Restrict results to a given event type.

  • SortOrderstringenum

    Sort direction: ASC or DESC.

    ASCDESC
  • SearchNamestring

    Name of the search filter/tag to apply.

  • SortColumnstring

    Field name to sort by.

  • SearchValuestring

    Value to match for the given search filter. Requires SearchName.

  • BatchReferenceIDstring

    Filter results to a specific batch reference ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Spondyr SSO stubSPONDYR_SSO_STUBAcción

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.

Parámetros de entrada

  • RolestringObligatorioenum

    Stub user's permissions. One of: Owner, Integrator, Editor, Tenant User.

    OwnerIntegratorEditorTenant User
  • LastNamestringObligatorio

    SSO user's last name (URL-encoded).

  • TimeZonestring

    Display timezone (IANA/Windows name). Defaults to UTC if omitted or invalid.

  • FirstNamestringObligatorio

    SSO user's first name (URL-encoded).

  • TenantTokenstring

    Tenant token for multi-tenant applications.

  • ApplicationUserIDstringObligatorio

    Your system's user identifier for the SSO user (URL-encoded).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TemplateSPONDYR_TEMPLATE_GETAcción

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

Parámetros de entrada

  • TemplatestringObligatorio

    The name of the Template to retrieve.

  • TransactionTypestringObligatorio

    The name of the Transaction Type this Template is for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List TemplatesSPONDYR_TEMPLATES_LISTAcción

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

Parámetros de entrada

  • TransactionTypestringObligatorio

    The name of the Transaction Type whose templates are to be listed

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Transaction TypeSPONDYR_TRANSACTION_TYPE_GETAcción

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

Parámetros de entrada

  • TransactionTypestringObligatorio

    The name of the Transaction Type to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Transaction TypeSPONDYR_TRANSACTION_TYPE_UPDATEAcción

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

Parámetros de entrada

  • NamestringObligatorio

    The name of the transaction type.

  • TemplateJSONstringObligatorio

    JSON-formatted string containing all available properties with sample data.

  • TransactionTypestringObligatorio

    The existing transaction type name to update.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not