ZAzahlo
Webhooks

Update a webhook endpoint

Update a webhook endpoint. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

patch/api/v1/webhook-endpoints/{id}

Request

  • Base URL
    https://merchant.zahlo.eu
  • Auth
    API key in header x-api-key

Path parameters

idstring required

The resource identifier returned by the merchant API.

Request body

urlstring uri required
enabledEventsstring[] required
descriptionstring
metadataobject

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

enabledboolean

Response

Resource updated

idstring required
object'webhook_endpoint' required
livemodeboolean required
createdAtstring date-time required
urlstring uri required
enabledEventsstring[] required
status'enabled' | 'disabled' required
descriptionstring nullable
metadataobject

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

failingSincestring date-time nullable

Start of the current run of failed deliveries; null while healthy. After 3 days the endpoint is disabled.

disabledReason'failing' | 'null' nullable

failing when Zahlo disabled the endpoint after 3 days of failures.

secretstring

Only in the create and rotate-secret responses.

Changes

No recorded changes to this operation across all 1 revision of this API.