Skip to main content
GET
Get a webhook

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The unique identifier of the webhook.

Query Parameters

expand
string | null

A comma-separated list of additional fields to expand. Supported values: provider_events (the per-provider event configuration). These are returned as null unless requested.

Example:

"provider_events"

Response

The webhook was retrieved.

id
string
required

The unique identifier of the webhook.

label
string
required

The display label of the webhook.

webhook_url
string
required

The URL webhook events are delivered to.

events
string[]
required

The unified event names the webhook is subscribed to (e.g. employee.created).

status
enum<string>
required

The status of the webhook.

Available options:
active,
inactive,
suspended,
archived,
expired,
error,
unmapped_value,
null
status_reasons
object[]
required

The reasons explaining the current status; empty when none are recorded.

provider_events
object | null
required

The per-provider event configuration, keyed by provider key and then by unified event name. Only resolved when expand=provider_events is requested; null otherwise.

created_at
string<date-time>
required

When the webhook was created.

updated_at
string<date-time>
required

When the webhook was last updated.

signing_secret
string | null
required

The secret used to sign webhook payloads, for signature verification; null when none is stored.