Get a webhook decision exchange

Retrieve a real-time decision exchange and its response by ID and version.

Required permissions: notification_decision_exchange:read.

Authentication

AuthorizationBearer

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

Path parameters

notification_decision_exchange_idstringRequired
The ID of the decision exchange.

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 decision exchange.
notification_decision_exchange_idstring
Penny's unique identifier for this decision exchange.
versioninteger
A number that increases each time this exchange's state changes. Use it to confirm you are looking at the latest information.
version_timedatetime
The date and time this exchange's state was last changed.
business_idstring
The business this decision concerns.
notification_endpoint_idstring
The webhook endpoint this decision request was sent to.
request_timedatetime
When the decision request was sent.
statusenum

This exchange’s current status: ‘pending’, ‘decided’, ‘timed_out’, or ‘failed’.

Allowed values:
requestobject
The decision that was requested.
channelenum
The channel this decision request was sent over.
Allowed values:
response_timedatetime or nullOptional
When a response was received, if one has been.
outcomeenum or nullOptional
The effective outcome of this exchange, once resolved.
Allowed values:
fallback_appliedbooleanOptionalDefaults to false
Whether the fallback outcome was applied because no response arrived in time.
responseobject or nullOptional
The subscriber's response, if one was received.
metadatamap from strings to any or nullOptional
Additional metadata associated with this exchange.

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