Documentation
Send a test event
POST
/v1/webhooks/{webhook}/testWebhooksSends a signed ping event now, paused or not, and answers with what the endpoint said.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
webhook | string, in the path | required | The endpoint's id. |
Example request
curl -s -X POST "https://snip.link/v1/webhooks/webhook/test" \ -H "Authorization: Bearer $SNIP_KEY"
Response fields
| Field | Type | Description |
|---|---|---|
result | object | |
result.ok | boolean | |
result.status | integer, null | |
result.ms | integer | |
result.error | string, null |
Errors
| Status | Meaning |
|---|---|
| 401 | The API key is missing, malformed or revoked. |
| 404 | No webhook endpoint by that id in this account. |
| 429 | Either the key exceeded its requests-per-second limit (honor Retry-After), or a daily or plan quota is used up (details.reason). |