Send a test event
Queue a webhook.test event to the webhook's saved URL, signed like a real event.
https://app.usenotix.dev/api/v1/webhooks/{webhookId}/testNeeds a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Queue a webhook.test event to the webhook's saved URL, signed like a real event. The answer is 202 with the callId; read the call to see how your endpoint answered. The request takes no URL: a test only ever goes to the URL saved on the webhook. A team can send 10 test events a minute.
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.
The team sent 10 test events in the last minute.
Every error has the same shape. See all error codes.
curl -X POST "https://app.usenotix.dev/api/v1/webhooks/<webhookId>/test" \
-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.test("wh_123");
console.log(data?.callId);
{
"callId": "cm1x8f3k20001qz7v5b9d2e4a"
}