API ReferencePlatformNotificationsWebhooksEvents

Get a webhook event

Retrieve a business notification event and its immutable payload by ID and version.

Required permissions: notification_event:read.

Authentication

AuthorizationBearer

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

Path parameters

notification_event_idstringRequired
The ID of the notification event.

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.

Response

The webhook event.
notification_event_idstring
Penny's unique identifier for this event.
versioninteger
A number that increases each time this event's record changes. Use it to confirm you are looking at the latest information.
version_timedatetime
The date and time this event's record was last changed.
business_idstring
The business this event belongs to.
typestring
The notification event type. This identifies the specific occurrence represented by the event.
categoryenum
The category of content carried by this event, such as an object change, alert, or message.
Allowed values:
event_timedatetime
When this event was generated.
occurrence_timedatetime
When the underlying occurrence took place.
payloadobject
The event exactly as it is delivered to a subscribed endpoint.
source_business_idstring or nullOptional
The business this event originated from, if different from the receiving business.

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