This webhook is sent when an account restriction has been successfully created.
Webhook Structure
string (UUID)
required
Unique identifier for this event
string (ISO 8601)
required
Timestamp of when the event occurred
string
Identifier to correlate the request with the response. Present when provided in the original request.
string
required
The type of event. Value:
account.restriction-createdobject
required
The event data containing the details below
Data Fields
string (UUID)
required
Unique identifier of the restricted account
string (UUID)
required
Unique identifier of the created restriction
string
required
Current restriction status. Available values:
ACTIVE, LIFTEDstring
required
Restriction type. Available values:
REJECT_OUTBOUND, REJECT_INBOUND, HOLD_INBOUNDstring
required
Restriction source. Available values:
CLIENT, PLAISstring
Free-text reason for the restriction
string
External reference associated with the restriction
string (ISO 8601)
required
Timestamp of when the restriction was created
string (ISO 8601)
required
Timestamp of when the restriction was last updated