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

List webhooks

List user-owned signed webhook subscriptions.

API 2.7.0 · Published service contract ↗

Request

Base URL: https://app.sym.so/v1/workspaces/{workspace_id}

Authentication: bearer. Required scope: webhooks:read.

GET /webhooks

List user-owned signed webhook subscriptions.

Request
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/webhooks" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "items": [
    {
      "id": "wh_01J8",
      "name": "Production events",
      "url": "https://example.com/symposium",
      "events": [
        "message.completed"
      ],
      "status": "active"
    }
  ],
  "supported_events": [
    "message.completed"
  ],
  "ok": true
}

Authorization

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

Errors

StatusDescription
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.