v1

latestOpenAPI 3.0.12026-07-2428103163.2 KB
Webhooks

Update webhook

Update the details of an existing webhook.

put/webhooks/{webhookId}

Path parameters

webhookIdstring uuid required

Unique identifier (GUID) of the webhook

Headers

Crezco-Versionstring

The requested API version

Request body

callbackstring uri required

The URL of the callback to register

Response

OK

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

Example response

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