Webhook

Webhook Model

FieldTypeDescriptionNullable
idStringA unique identifier for interacting with webhookfalse
allowedEventsEnum(String)Events sent to the webhook: all, or one of the events in the Webhooks overviewfalse
clientIdStringInternal unique identifierfalse
createdDate(String)Date of creation of webhookfalse
retryStatusEnum(String)Describes if webhook should be retried/resent if failed: 'ENABLED', 'DISABLED'false
secretHashStringSecret used as the HMAC-SHA256 key to sign each eventfalse
updatedDate(String)Most recent date of update on webhookfalse
urlStringValid webhook url to which transaction webhooks are sentfalse

Sample response

{
    "allowedEvents": "all",
    "clientId": "39a1e4bf-fbc3-4b78-9555-c50f8cfa17bw",
    "created": "2022-08-24T07:05:40.432Z",
    "id": "39a1e4bf-fbc3-4b78-9555-c50f8cfa17bw",
    "retryStatus": "ENABLED",
    "secretHash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
    "updated": "2022-08-24T07:05:40.432Z",
    "url": "https://example.com/webhook"
}