Skip to navigation
AgentsTriggers

Triggers · Create a trigger

View as Markdown

Creates a trigger — what makes an agent run on its own: a schedule, a webhook, or a chat channel.

config must match the shape the chosen kind expects. A mismatched config is accepted and produces a trigger that never fires correctly, so read the kind’s expected shape first rather than guessing.

resource: agent://build-guide covers the trigger lifecycle.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
agentstringOptional
Agent UUID this trigger fires.
namestringOptional
descriptionstringOptional
kindenumOptional

What causes a run. scheduled requires command; the chat kinds route inbound messages and are normally created by connecting the channel in the UI rather than here.

Allowed values:
statusenumOptional
Allowed values:
commandstringOptional

The instruction sent to the agent when the trigger fires. Required for scheduled.

deliverymap from strings to anyOptional
Where the result goes. Interpreted by the agent, not the dispatcher.
extramap from strings to anyOptional

Kind-specific configuration, including the schedule itself for scheduled triggers. Read agents_listTriggerKinds for the shape.

Response

The created trigger.

Errors

400
Bad Request Error