List event types

List every event type an endpoint can subscribe to, with the scope it needs.

GET /api/v1/event_types

cURL

curl "https://api.wordsmith.ai/api/v1/event_types" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "items": [
    {
      "type": "task.assigned",
      "scope": "tasks:read",
      "description": "A task got a new assignee or team.",
      "customer": true
    },
    {
      "type": "operation.succeeded",
      "scope": null,
      "description": "An operation you started succeeded.",
      "customer": false
    }
  ]
}

Returns every event type, the scope a credential needs to receive it, and whether organisation endpoints can receive it. An operation event’s scope depends on the operation’s type, so it names none.

​

Authentication

Requires an API key, or an OAuth token with webhooks:read.

​

Response

Returns the event types.

cURL

curl "https://api.wordsmith.ai/api/v1/event_types" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "items": [
    {
      "type": "task.assigned",
      "scope": "tasks:read",
      "description": "A task got a new assignee or team.",
      "customer": true
    },
    {
      "type": "operation.succeeded",
      "scope": null,
      "description": "An operation you started succeeded.",
      "customer": false
    }
  ]
}

​

Errors

Status	error_code	When
404	resource_not_found	Webhooks are not on for your organisation.