List event types
Every event type an endpoint can subscribe to, in the order a picker shows them, with a group and what it says. Subscribe to "*" for all of them, those added later too. New types may be added at any time, so receivers ignore types they do not know.
GET
/v1/webhooks/event-typesRequest
| Method and path | GET/v1/webhooks/event-types |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
curl "https://api.boxline.dev/v1/webhooks/event-types" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst { data, all } = await bx.webhooks.eventTypes();for (const e of data) console.log(e.group, e.type, e.description);console.log("every type, also later ones:", all); // "*"from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLtypes = bx.webhooks.event_types()for e in types["data"]: print(e["group"], e["type"], e["description"])print("every type, also later ones:", types["all"]) # "*"Responses
200 OK
The types.
Fields
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
data | object[] | – | – | |
data[].type | string | – | session.started, session.expiring, session.stopped, session.deleted, agent_run.started, agent_run.waiting, agent_run.resumed, agent_run.finished, captcha.waiting, captcha.solved, captcha.failed, crawl.finished, task_run.started, task_run.finished, task.schedule_paused, usage.limit_reached, api_key.created, api_key.revoked, credential.code_needed, credential.changed, webhook.changed, webhook.disabled, extension.uploaded, extension.deleted | The events an endpoint can subscribe to (GET /v1/webhooks/event-types lists them with descriptions). webhook.test is sent only by "send test" and needs no subscription. New types may be added: receivers ignore types they do not know. |
data[].group | string | – | – | |
data[].description | string | – | – | |
all | string | – | * | Subscribe to it for every type. |
{ "data": [ { "type": "session.started", "group": "sessions", "description": "…" } ], "all": "*"}Errors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.