Sign in

v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Webhooks

Update the status of a webhook

Updates the status of a specific webhook endpoint by ID

patch/api/webhook/{webhookId}

Path parameters

webhookIdstring required
Example:webhookId_1234567890abcdef

Unique identifier of the webhook

Request body

status'disabled' | 'enabled' required

Status of the webhook

Example request

{
  "status": "disabled"
}

Response

Update the status of a webhook successful

webhookIdstring required

Unique identifier of the webhook

webhookUrlstring required

HTTPS URL where webhook notifications will be sent

status'enabled' | 'disabled' required

Status of the webhook

failureReasonstring required

Failure reason of the webhook

Example response

{
  "webhookId": "webhook_1234567890abcdef",
  "webhookUrl": "https://api.example.com/webhook",
  "status": "disabled",
  "failureReason": "failure reason"
}