Get a webhook
Returns the webhook, including the signing secret used to verify payload signatures.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The unique identifier of the webhook.
Query Parameters
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.
"provider_events"
Response
The webhook was retrieved.
The unique identifier of the webhook.
The display label of the webhook.
The URL webhook events are delivered to.
The unified event names the webhook is subscribed to (e.g. employee.created).
The status of the webhook.
active, inactive, suspended, archived, expired, error, unmapped_value, null The reasons explaining the current status; empty when none are recorded.
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.
When the webhook was created.
When the webhook was last updated.
The secret used to sign webhook payloads, for signature verification; null when none is stored.