Skip to main content
Use this endpoint to permanently delete a webhook endpoint. Once deleted, VelaFi immediately stops sending event notifications to the associated URL. Deleted webhooks appear in List Webhooks with status: 30 but cannot be restored — create a new webhook if you need to re-register the same URL or event type.
All requests must include the X-BH-TOKEN header with a token from GET /v2/token/generate (see Authentication). Deletion is irreversible.

Endpoint

DELETE https://api.velafi.com/v2/webhook/{webhookId}

Path Parameter

string
required
The unique ID of the webhook to delete. Obtain this from the List Webhooks response.

Response Fields

number
HTTP-style response code. 200 indicates success.
string
Human-readable status message, e.g. SUCCESS.
boolean
true if the webhook was deleted.

Example

cURL
Response
Deletion is permanent and cannot be undone. Events that occur while no active webhook exists for the event type are not queued. Events already queued are not cancelled: if you create a new webhook for the same event type within about 15 days, they are delivered to the new webhook’s URL with the deleted webhook’s webhookId. Create a new webhook immediately if you need continued delivery.