API ReferencePlatformNotificationsWebhooks

Get a webhook

Retrieve a webhook by ID and version. Its URL, authentication token, and signing secret are masked by default; set reveal_sensitive to true to include their real values.

Required permissions: notification_endpoint:read.

Authentication

AuthorizationBearer

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

Path parameters

notification_endpoint_idstringRequired
The ID of the webhook endpoint.

Headers

X-Penny-As-Businessstring or nullOptional

Act on behalf of another business that has granted you access. Requires the business:act_as permission.

Query parameters

versionintegerOptional>=0Defaults to 0

Resource version to return; 0 returns the latest.

reveal_sensitivebooleanOptionalDefaults to false
Whether to include unmasked sensitive fields in the response. Defaults to false.

Response

The webhook.
notification_endpoint_idstring
Penny's unique identifier for this endpoint.
versioninteger
A number that increases each time this endpoint's details change. Use it to confirm you are looking at the latest information.
version_timedatetime
The date and time this endpoint's details were last changed.
business_idstring
The business this endpoint belongs to.
statusenum

This endpoint’s current status: ‘pending_setup’, ‘setup_failed’, ‘pending_verification’, ‘verification_failed’, ‘updating’, ‘active’, ‘deactivated’, ‘suspended’, or ‘archived’.

enabledboolean
Whether this endpoint currently receives deliveries.
updatingboolean
Whether this endpoint is currently being updated.
archivedboolean
Whether this endpoint has been permanently retired.
created_timedatetime
When this endpoint was registered.
verificationobject

The ownership-verification state of this endpoint.

suspensionobject
Whether this endpoint is currently suspended, and why.
channelenum
The delivery channel for this endpoint.
Allowed values:
urlstring
The HTTPS URL event payloads are delivered to. Shown as a masked placeholder unless the request explicitly asks to reveal sensitive values.
has_authentication_tokenboolean

Whether a bearer authentication token is configured. The token is write-only and is never returned.

has_signing_secretboolean
Whether a signing secret is configured. The secret is returned only when created or rotated.
trigger_eventslist of stringsOptional
The events this endpoint is subscribed to.
filter_identifierslist of stringsOptional
The specific objects this endpoint's subscription is scoped to, if any. Empty means it receives events for every object.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error