CreateConnector

The CreateConnector action creates a new connector for a specified integration. Connectors are the communication channels through which the agent interacts with external services.

CreateConnector(
    integrationIdn: str,
    connectorIdn: str,
    title: str,
    settings: dict = {},
    start: bool = True
)

Parameters

Parameter	Type	Default	Description
`integrationIdn`	`str`		The integration identifier (e.g., `"program_timer"`, `"api"`, `"twilio_messenger"`).
`connectorIdn`	`str`		The unique identifier for the connector being created.
`title`	`str`		The display title for the connector.
`settings`	`dict[str, str]`		(Optional but if empty must be `settings={}`) A dictionary of settings for the connector (e.g., `{"channel": "text"}`).
`start`	`bool`	`True`	(Optional) Whether to start the connector immediately after creation. Defaults to `True`.

Returns object with properties

Parameter	Type	Description
`integrationIdn`	`str`	The integration identifier of the connector.
`connectorIdn`	`str`	The unique identifier of the connector.
`title`	`str`	The display title of the connector.
`status`	`Literal["running", "stopped"] \| None`	The current status of the connector, or `None`.
`settings`	`dict[str, str]`	A dictionary of settings for the connector.

Example

{{ CreateConnector(
    integrationIdn="program_timer",
    connectorIdn="my_timer",
    title="My Timer",
    settings={},
    start=True
) }}

The above code snippet creates a new programmable timer connector with the identifier "my_timer" and starts it immediately.