Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

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

Headers

Project-Id
string

The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.

Path Parameters

id
string
required

The ID of the webhook to get.

Response

Webhook retrieved 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.