SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

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.

ParameterTypeDescription
webhook_id
path · required
stringActive user-owned webhook ID.
Request
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}"
Response 202
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "event_id": "evt_01J8",
  "queued": true,
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "webhooks:write",
  "transport": "Authorization: Bearer <workspace_api_key>"
}

Errors

StatusDescription
400The request body or parameters are invalid.
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.