DELETE `/api/v1/webhooks/{id}`

Delete a webhook.

Scope webhooks:write
operationId webhooksDelete

The token needs the scope webhooks:write, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

DELETE /api/v1/webhooks/{id}

Path parameters

Name	Description	Example
`id`	The id of the webhook.	`2`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl -X DELETE "https://vestoris.com/api/v1/webhooks/2" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.delete(
    "https://vestoris.com/api/v1/webhooks/2",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # 204: no content

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/webhooks/2", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
if (!res.ok) throw new Error((await res.json()).detail); // 204: no content

Response

204 No Content: done, with an empty body.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
204	Done (no content)
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
409	Not possible in the current state	`invalid_transition` `conflict`
422	Validation failed (the detail says which field), or blocked	`validation_failed`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/webhooks/2"
}

On the screens

The same thing in the app is explained in:

API clients and webhooks