Deactivate a webhook

Deactivates a webhook registration. The record is retained for history but cannot be reactivated; to receive that event type again, register a fresh webhook.

DELETE /webhooks/{webhookId}

Deactivate a webhook

cURL

curl --request DELETE \
  --url https://api.zeam.money/gw/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'

401

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Access token issued by POST /v1/auth/token.

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Path Parameters

webhookId · string<uuid> · required

Webhook registration identifier.

Response

204

Webhook deactivated.