Delete a webhook
Stop sending events to this URL for good.
https://app.usenotix.dev/api/v1/webhooks/{webhookId}Needs a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Stop sending events to this URL for good. The webhook and its call log are deleted, and this cannot be undone. To stop events for a while, pause it instead.
Who can call it
A full access key created by a team admin, as on the dashboard. Every refusal is 403:
| Code | Why |
|---|---|
SCOPE_DENIED | The key is not a full access key (send-only, read-only or live AI). |
DOMAIN_PINNED | The key is limited to one domain. A webhook receives the events of every domain. |
FORBIDDEN | The key was made by a team member without admin rights, or before Notix recorded who made each key. Create a new key as a team admin. |
Adding a webhook, pointing one at a new URL or removing one emails the team's owner and admins, naming the key.
Path parameters
Headers
Bearer followed by your API key.
Errors
`SCOPE_DENIED`: the key is not a full access key (send-only, read-only or live AI). `DOMAIN_PINNED`: the key is limited to one domain. `FORBIDDEN`: the key was made by a team member without admin rights, or before Notix recorded who made each key (create a new key).
No webhook with this id for the calling team.
Every error has the same shape. See all error codes.
curl -X DELETE "https://app.usenotix.dev/api/v1/webhooks/<webhookId>" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.webhookEndpoints.delete("wh_123");
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"deleted": true
}