Webhooks

Edit a webhook endpoint

Send only the fields to change. status turns delivery off (disabled) or back on (enabled); disabling cancels deliveries waiting to be retried. A new url clears failing_since. An endpoint disabled after 7 days of failed deliveries (disabled_reason: failing) is sent a webhook_endpoint.test event first, to the new url if this request changes it, and is enabled only if it answers 2xx within 10 seconds; otherwise the response is 422 and it stays disabled. The test appears in the endpoint's deliveries.

patch/v1/webhook_endpoints/{id}

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/webhook_endpoints/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

One webhook.

Changes

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