Queue a webhook test
Queue a signed webhook.test delivery using a synthetic payload and the normal durable delivery system.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: webhooks:write.
POST /webhooks/{webhook_id}/test
Queue a signed webhook.test delivery using a synthetic payload and the normal durable delivery system.
| Parameter | Type | Description |
|---|---|---|
webhook_idpath · required | string | Active user-owned webhook ID. |
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/webhooks/$WEBHOOK_ID/test" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
-H "Content-Type: application/json" \
--data "{\"proof\":true}"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"event_id": "evt_01J8",
"queued": true,
"ok": true
}Authorization
{
"type": "bearer",
"scope": "webhooks:write",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 400 | The request body or parameters are invalid. |
| 401 | The workspace API key is missing, invalid, expired, or revoked. |
| 403 | The key lacks the required scope or its owner no longer has permission. |
| 404 | The resource is missing or intentionally hidden by authorization. |
| 429 | The key exceeded its current rate limit. |