Skip to main content
client.deployments publishes an agent to a channel (embed widget, Slack, form, …). client.triggers reads and manages workflow triggers and the events they receive.

Deployments

A deployment is “this agent, on this channel, with this config”. It starts inactive; activate builds its trigger and goes live.

Discover channels

Create → activate

Deployments and their config are returned as plain dicts (secrets redacted). Activation requires assistant_version_id to be set and the agent version to be valid.

Manage

Mutating an active deployment’s config or assistant_version_id rebuilds its trigger automatically.

Events

The events the deployment’s trigger has received (deliveries, failures):
Async twins throughout: acreate, aactivate, adeactivate, aupdate, adelete, alist, aget, alist_channels, alist_events, aiter_events.

Triggers (workflow)

Triggers fire a workflow on an external event (schedule, webhook, …).
definition is the trigger config dict (its shape depends on type). A trigger is pinned to a workflow_version_id. Every method has an a-prefixed async twin.
Agent triggers (as opposed to workflow triggers) are managed from an Agent object: agent.add_trigger(trigger_data) and agent.triggers(). See Agents.