Skip to main content
Create a webhook

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

The webhook's name, used to identify it in the dashboard

Minimum string length: 1
url
string<uri>
required

The webhook's URL. We'll call this URL when an event occurs.

eventTypes
enum<string>[]
required

Event types this webhook subscribes to. One webhook URL receives all events you list here.

Minimum array length: 1
Available options:
QUEUE_ITEM_NEW,
QUEUE_ITEM_COMPLETED,
QUEUE_ITEM_ACTION,
QUEUE_ITEM_REJECTED,
QUEUE_ITEM_ALLOWED,
AUTHOR_BLOCKED,
AUTHOR_UNBLOCKED,
AUTHOR_SUSPENDED,
AUTHOR_UPDATED,
AUTHOR_TRUST_LEVEL_CHANGED,
AUTHOR_ACTION
description
string | null

The webhook's description

Response

Webhook created successfully

id
string
required

The ID of the webhook.

name
string
required

The webhook's name.

url
string
required

The URL we call when a subscribed event occurs.

eventTypes
enum<string>[]
required

Event types this webhook subscribes to. Empty for legacy v1 webhooks, which subscribe via their single deprecated type instead.

Available options:
QUEUE_ITEM_NEW,
QUEUE_ITEM_COMPLETED,
QUEUE_ITEM_ACTION,
QUEUE_ITEM_REJECTED,
QUEUE_ITEM_ALLOWED,
AUTHOR_BLOCKED,
AUTHOR_UNBLOCKED,
AUTHOR_SUSPENDED,
AUTHOR_UPDATED,
AUTHOR_TRUST_LEVEL_CHANGED,
AUTHOR_ACTION
payloadVersion
enum<string>
required

Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat shape and is read-only via this API.

Available options:
V1,
V2
createdAt
string
required

The date the webhook was created.

description
string | null

The webhook's description.