Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

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

Headers

idempotency-key
string
required
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json
url
string
required
Required string length: 1 - 2048
events
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
run.started,
run.completed,
run.failed,
agent.response.completed,
agent.response.failed
description
string | null
Maximum string length: 500

Response

Success

endpoint
object
required
secret
string
required
Required string length: 1 - 256