API ReferenceWebhooks

Retrieve a Webhook

Retrieves the details of an existing webhook, including its secret.

Path parameters

webhook-idstringRequired

Webhook’s ID (starts with “wbh_”)

Headers

AuthorizationstringRequired

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

Key-InflectionenumOptional
Determines casing for the API response
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent
Persona-VersionenumOptionalDefaults to 2023-01-05
Allowed values:

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Response

OK
dataobject or null
A Webhook object
includedlist of any or null

Excluded from the response by default. Will be an empty array when the include query parameter in the request was explicitly set to empty.

Errors