webhooks

Delete an existing webhook endpoint. Only the creator or admin can delete a webhook. (pay-authenticated access required)

Delete a webhook endpoint

delete/webhooks

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/webhooks
  • Auth: API key in header token

Request body

webhookIdstring required

The ID of the webhook to delete

Example request

{
  "webhookId": "webhook_endpoint_id"
}

Response

Webhook endpoint deleted successfully

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "id": "webhook_endpoint_id",
    "url": "https://your-server.com/webhook",
    "name": "My Payment Webhook",
    "deletedAt": "1970-01-20T20:00:36.260Z"
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.