Skip to main content
POST
Create webhook endpoint
Use a workspace Management Token (mt-...), not an inference API key (sk-...) or signing secret (whsec_...). Create one at Dashboard → API → Management Tokens and send Authorization: Bearer mt-.... Access is scoped to that workspace. See Webhook management API guide for events, verification, retries and troubleshooting.

Authorizations

Authorization
string
header
required

Management token authentication. Create or manage Management Tokens in Dashboard > API > Management Tokens.

Body

application/json
url
string<uri>
required

Public HTTPS receiver URL. Credentials, query strings, fragments, private or reserved network targets and redirects are rejected.

events
enum<string>[]
required

Supported event subscriptions; duplicates are removed.

Required array length: 1 - 10 elements
Available options:
task.completed,
task.failed,
task.timeout
description
string
Maximum string length: 200

Response

Create webhook endpoint result

id
string
required
object
enum<string>
required
Available options:
webhook_endpoint
url
string
required
events
enum<string>[]
required
Available options:
task.completed,
task.failed,
task.timeout
is_active
boolean
required
description
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
last_delivered_at
string<date-time> | null
required
failure_count
integer
required
secret
string
required