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

Create a webhook

Create an HTTPS-only subscription. The signing secret is revealed once.

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

Create an HTTPS-only subscription. The signing secret is revealed once.

Request
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/webhooks" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"name\":\"Production events\",\"url\":\"https://example.com/symposium\",\"events\":[\"message.completed\"]}"
Response 201
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "item": {
    "id": "wh_01J8",
    "name": "Production events",
    "url": "https://example.com/symposium",
    "events": [
      "message.completed"
    ],
    "status": "active"
  },
  "signing_secret": "whsec_…",
  "reveal_once": 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.
429The key exceeded its current rate limit.