Sign in

v1

latestOpenAPI 3.0.12026-07-2428103163.2 KB
Webhooks

Register webhook

Register a new webhook to receive asynchronous callbacks whenever a pay run or an underlying payment has changed

post/webhooks

Headers

Crezco-Versionstring

The requested API version

Request body

eventType'Unknown' | 'PayRun' | 'Batch' | 'Group' | 'Payable' | 'Authorisation' | 'BankAccount' | 'OrganisationOnboarding' | 'Feature' | 'Verification' required
callbackstring required

The URL of the callback to register

versionstring required

The webhook version associated to the subscription <example>2024-06-30</example>

Response

Created

webHookIdstring uuid

The Id of the WebHook in the Crezco system

eventType'Unknown' | 'PayRun' | 'Batch' | 'Group' | 'Payable' | 'Authorisation' | 'BankAccount' | 'OrganisationOnboarding' | 'Feature' | 'Verification'
callbackstring

The URL of the callback to register

versionstring required

Example response

{
  "webHookId": "8cefae8a-ab99-4ce0-b364-1e4426c4dfda"
}