Skip to main content
POST
Send an event to trigger the agent

Authorizations

x-agent-api-key
string
header
required

Agent API key (sk-...) bound to a single agent. Authenticates the webhook event trigger (POST /messaging/v1/events) only.

Body

application/json

An event from an external system that triggers the agent bound to your webhook credential.

text
string | null

The message to run the agent on. When omitted, the agent runs on agent_variables alone.

agent_variables
Agent Variables · object

Free-form key/value data passed to the agent as variables for this event.

thread_id
string | null

Your own id for the conversation this event belongs to. Reuse the same value to continue a conversation; omit it to start a new one. Unique per agent.

Required string length: 1 - 255

Response

Successful Response

Acknowledgement that an event was durably enqueued (not yet processed).

event_id
string
required

Unique id minted for this event; follows it everywhere.