Pause or resume a webhook
Set status to PAUSED to stop sending events, or ACTIVE to start again.
https://app.usenotix.dev/api/v1/webhooks/{webhookId}/statusNeeds a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Set status to PAUSED to stop sending events, or ACTIVE to start again. Resuming also clears the failure count, so a webhook Notix turned off after repeated failures (AUTO_DISABLED) can be turned back on once your endpoint works.
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
Body parameters
ACTIVE sends events again (and clears the failure count); PAUSED stops sending them.
One of ACTIVE, PAUSED.
Headers
Bearer followed by your API key.
Errors
`status` is not ACTIVE or PAUSED.
`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 POST "https://app.usenotix.dev/api/v1/webhooks/<webhookId>/status" \
-H "Authorization: Bearer $NOTIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "PAUSED"
}'
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.webhookEndpoints.setStatus("wh_123", "PAUSED");
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"url": "string",
"description": "string",
"status": "ACTIVE",
"eventTypes": [
"string"
],
"domainIds": [
1
],
"apiVersion": "string",
"consecutiveFailures": 1,
"lastFailureAt": "string",
"lastSuccessAt": "string",
"secretHint": "whsec_••••••••••••••••••••••••",
"createdAt": "string",
"updatedAt": "string"
}