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

Update a webhook

Change a user-owned webhook name, HTTPS destination, subscribed events, or active/paused status.

API 2.7.0 · Published service contract ↗

Request

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

Authentication: bearer. Required scope: webhooks:write.

PATCH /webhooks/{webhook_id}

Change a user-owned webhook name, HTTPS destination, subscribed events, or active/paused status.

ParameterTypeDescription
webhook_id
path · required
stringUser-owned webhook ID.
Request
curl --fail-with-body -X PATCH "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/webhooks/$WEBHOOK_ID" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"name\":\"Production events\",\"events\":[\"message.completed\"],\"status\":\"paused\"}"
Response 200
{
  "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": "paused",
    "updated_at": "2026-08-05T08:32:00Z",
    "revoked_at": null
  },
  "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.