Skip to main content
POST
/
v1
/
agents
/
webhook
/
trigger
TriggerAgentWebhook
curl --request POST \
  --url https://app.textql.com/v1/agents/webhook/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "triggerId": "00000000-0000-0000-0000-000000000000",
  "payload": {
    "event": "example.event",
    "source": "manual-test"
  }
}
'
{
  "status": "<string>"
}
Use this endpoint to start an agent run from an external system. The webhook payload is added as context for the agent run.
Webhook payloads are limited to 16KB after JSON serialization. Requests with larger payloads are rejected before the agent run is queued.
You can find an agent’s webhook trigger ID from the agent edit page in TextQL.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
​
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
​
triggerId
string<uuid>
required

The webhook trigger ID for the agent.

​
payload
payload · object

JSON payload to pass to the agent as run context. Limited to 16KB after JSON serialization.

Response

Success

​
status
string

Queue status for the agent run.

Example:

"queued"