Spondyr | Composio Docs

Overview

SLUG: SPONDYR

Description

Template description for spondyr

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Spondyr

Create an auth config

Use the dashboard to create an auth config for the Spondyr toolkit. This allows you to connect multiple Spondyr accounts to Composio for agents to use.

Select App

Navigate to Spondyr.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Spondyr Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 spondyr_auth_config_id = "ac_YOUR_SPONDYR_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": user_api_key}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Spondyr for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, spondyr_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Spondyr toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["SPONDYR"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

SPONDYR_CONDITIONS_LIST

Tool Name: List Conditions

Description

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

SPONDYR_CREATE_CONDITION

Tool Name: Create Condition

Description

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

SPONDYR_CREATE_TRANSACTION_TYPE

Tool Name: Create Transaction Type

Description

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

SPONDYR_DELIVER_SPONDYR

Tool Name: Deliver Spondyr correspondence

Description

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

SPONDYR_EVENT_TYPE_UPDATE

Tool Name: Update Event Type

Description

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

SPONDYR_GET_EVENT_TYPES

Tool Name: List Event Types

Description

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

SPONDYR_GET_SPONDYR_STATUS

Tool Name: Get Spondyr Status

Description

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

SPONDYR_GET_TRANSACTION_TYPES

Tool Name: Get Transaction Types

Description

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

SPONDYR_RECIPIENTS_LIST

Tool Name: List Recipients

Description

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

SPONDYR_RECIPIENT_DELETE

Tool Name: Delete Recipient

Description

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

SPONDYR_RECIPIENT_GET

Tool Name: Get Recipient

Description

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

SPONDYR_SEARCH_FILTERS_LIST

Tool Name: List Search Filters

Description

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

SPONDYR_SEARCH_FILTER_CREATE

Tool Name: Create Search Filter

Description

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

SPONDYR_SEARCH_FILTER_DELETE

Tool Name: Delete Search Filter

Description

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

stringRequired

TransactionType

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SPONDYR_SEARCH_FILTER_GET

Tool Name: Get Search Filter

Description

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

stringRequired

TransactionType

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SPONDYR_SEARCH_SPONDYRS

Tool Name: Search Correspondence

Description

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

SPONDYR_SSO_STUB

Tool Name: Create Spondyr SSO stub

Description

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

SPONDYR_TEMPLATES_LIST

Tool Name: List Templates

Description

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

SPONDYR_TEMPLATE_GET

Tool Name: Get Template

Description

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

SPONDYR_TRANSACTION_TYPE_GET

Tool Name: Get Transaction Type

Description

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

SPONDYR_TRANSACTION_TYPE_UPDATE

Tool Name: Update Transaction Type

Description

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