Skip to main content
GET
Get Webhook

Authorizations

x-api-key
string
header
required

Headers

Pulse-Version
string
default:2

Path Parameters

webhook_id
string
required

The webhook_id that POST /webhook returned.

Response

The webhook.

One of your organization's webhooks, without its secret.

webhook_id
string
required

The webhook's id, webhook-<uuid>.

url
string
required

The URL Pulse sends this webhook's events to.

events
enum<string>[]
required

The events this webhook receives. An empty list means none.

Available options:
parse.queued,
parse.processing,
parse.completed,
parse.failed,
parse.canceled,
extract.queued,
extract.processing,
extract.completed,
extract.failed,
extract.canceled,
split.queued,
split.processing,
split.completed,
split.failed,
split.canceled,
classify.queued,
classify.processing,
classify.completed,
classify.failed,
classify.canceled,
tables.queued,
tables.processing,
tables.completed,
tables.failed,
tables.canceled,
charts.queued,
charts.processing,
charts.completed,
charts.failed,
charts.canceled,
pipeline.queued,
pipeline.processing,
pipeline.completed,
pipeline.failed,
pipeline.canceled
events_from
Events From · object
required

For each event, the time it takes effect. The event is sent only for jobs created after that time.

enabled
boolean
required

Whether Pulse sends events to this webhook. It's false when you or Pulse turned the webhook off.

disabled_reason
enum<string> | null
required

Why Pulse turned the webhook off: delivery_failures (10 events in a row undelivered, or 3 days of failed deliveries) or gone (your endpoint returned 410). It's null while on, or if you turned it off.

Available options:
delivery_failures,
gone
header_names
string[]
required

The names of the webhook's static headers. Their values are never returned.

created_at
string
required

When the webhook was created.

description
string | null
required

Your note about the webhook, or null if you gave none.