> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.jelliu.co/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.jelliu.co/_mcp/server. # List webhook event types GET https://api.jelliu.co/api/webhooks/event-types Returns the event types available for subscription, each with English and Spanish descriptions, whether the `"*"` wildcard covers it, and a representative `data` example. This is the authoritative list of values accepted in `events`. `webhook.test` is listed (it can be sent with `POST /api/webhooks/{webhookId}/test`) but cannot be subscribed to. The [Webhooks guide](/webhooks#event-catalog) presents the same catalog as a table. **Idempotency.** A read with no side effects. Safe to retry. **Access** * **Required scope:** `read` or `write`. Any workspace role can call it. * **Rate limit:** General API — 120 requests/min per workspace on Starter or with no active plan, 200 on Growth, 300 on Business, 600 on Enterprise. See [Rate limits](/rate-limits). * **Plan:** Available on every plan and also without an active subscription. See [Billing and usage](/platform/billing-and-usage#without-an-active-subscription). Reference: https://developer.jelliu.co/api-reference/webhooks/get-webhooks-event-types ## Authentication - `Authorization` header (bearer token, required) — Workspace API key: `jl_` followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (**Settings → API Keys**) and sent as `Authorization: Bearer jl_...`. The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys. | Scope | GET / HEAD | POST / PUT / PATCH / DELETE | Admin-only routes | | --- | --- | --- | --- | | `read` | Yes | No | No | | `write` | Yes | Yes | No | | `full` | Yes | Yes | Yes | Operations restricted to admins or owners reject keys without the `full` scope with `403`, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See [Authentication](/authentication). ## Response ### 200 The subscribable event types, in catalog order. - `data` (list of WebhookEventType, required) ## Errors ### 401 Unauthorized Error No usable credential. Either the `Authorization` header is missing or is not a well-formed `Bearer jl_…` key, or the key is unknown, revoked or expired. Do not retry with the same key. See [Authentication](/authentication#401-unauthorized). - `error` (ErrorResponseError, required) — The error object. Always has `code` and `message`. ### 403 Forbidden Error Authenticated, but not allowed: the key's scope does not cover the method, the route is restricted to workspace admins/owners and the key is not `full`, or the workspace is suspended (`TENANT_SUSPENDED`). See [Authentication](/authentication#scopes). - `error` (ErrorResponseError, required) — The error object. Always has `code` and `message`. ### 429 Too Many Requests Error Rate limit exceeded for the current 60-second window (`RATE_LIMIT_EXCEEDED`). Wait `Retry-After` seconds, then retry. The `message` differs per limiter; the code does not. See [Rate limits](/rate-limits). - `error` (ErrorResponseError, required) — The error object. Always has `code` and `message`. ## Types ### WebhookEventType One entry of `GET /api/webhooks/event-types`. - `type` (string, required) — The event type, as sent in the envelope's `type` and the `x-jelliu-event-type` header. - `category` (string, required) — Group the type belongs to (`call`, `conversation`, `message`, `contact`, `campaign`, `agent`, `approval`, `agent_action`, `appointment`, `payment`, `knowledge`, `lesson`, `whatsapp`, `integration`, `phone_number`, `billing`, `crm`, `audit`, `meta`). - `description_en` (string, required) — When the event is sent and what `data` contains, in English. - `description_es` (string, required) — The same description in Spanish, as shown in the dashboard. - `opt_in_only` (boolean, required) — `true` when `"*"` does not cover the type and it must be listed explicitly in `events`. - `example` (map from string to any, required) — A representative `data` object for this type, in snake_case, as delivered to the endpoint. ### ErrorResponseError The error object. Always has `code` and `message`. - `code` (string, required) — Stable machine-readable error code (for example `VALIDATION_FAILED`, `PAYLOAD_TOO_LARGE`, `UNAUTHORIZED`, `FORBIDDEN`, `NOT_FOUND`, `BILLING_ERROR`, `COMPLIANCE_BLOCKED`, `RATE_LIMIT_EXCEEDED`, `INTERNAL_ERROR`). Switch on this, not on `message`. See [Errors](/errors). - `message` (string, required) — Human-readable explanation. English or Spanish depending on the route; may change without notice. - `details` (ErrorResponseErrorDetails, optional) — Present on `VALIDATION_FAILED` only. Its shape depends on how the route validates: * a field map, either Zod's `flatten()` output (`{ "formErrors": [], "fieldErrors": { "name": ["..."] } }`) or just its `fieldErrors` part (`{ "name": ["..."] }`); * an issue list, where each issue has at least `path`, `message` and `code`. `path` is a dot-separated string on routes that let the schema throw, and an array of keys on routes that forward Zod's raw issues (those also carry Zod's extra issue fields); * for a rejected multipart upload (file in an unexpected field, too many files), a list with the upload error `code` (for example `LIMIT_UNEXPECTED_FILE`) and the `field` name. Absent when the value was rejected outside the route's own validation: a malformed id, number or date the database could not read, or a JSON body that does not parse. - `metadata` (map from string to any, optional) — Structured detail exposed for a small allowlist of codes only — for example `BILLING_ERROR` carries `limit`, `current` and `tier` (resource caps), `tier` alone (feature gates), or `tier` = `none` with `kind` = `subscription_required` when the workspace has no active subscription. See [Errors](/errors). ### ErrorResponseErrorDetails Present on `VALIDATION_FAILED` only. Its shape depends on how the route validates: * a field map, either Zod's `flatten()` output (`{ "formErrors": [], "fieldErrors": { "name": ["..."] } }`) or just its `fieldErrors` part (`{ "name": ["..."] }`); * an issue list, where each issue has at least `path`, `message` and `code`. `path` is a dot-separated string on routes that let the schema throw, and an array of keys on routes that forward Zod's raw issues (those also carry Zod's extra issue fields); * for a rejected multipart upload (file in an unexpected field, too many files), a list with the upload error `code` (for example `LIMIT_UNEXPECTED_FILE`) and the `field` name. Absent when the value was rejected outside the route's own validation: a malformed id, number or date the database could not read, or a JSON body that does not parse. - Field map: Field map - Issue list: list of ErrorResponseErrorDetailsOneOf1Items ### Field map - `formErrors` (list of string, optional) - `fieldErrors` (map from string to list of string, optional) ### ErrorResponseErrorDetailsOneOf1Items - `path` (ErrorResponseErrorDetailsOneOf1ItemsPath, optional) — Dot-separated string, or an array of keys. - `message` (string, optional) - `code` (string, optional) — Zod issue code, for example `invalid_type`. ### ErrorResponseErrorDetailsOneOf1ItemsPath Dot-separated string, or an array of keys. - string - list of ErrorResponseErrorDetailsOneOf1ItemsPathOneOf1Items ### ErrorResponseErrorDetailsOneOf1ItemsPathOneOf1Items - string - integer ## Examples **Response** ```json { "data": [ { "type": "call.completed", "category": "call", "description_en": "Sent when a call ends after a conversation. Includes the outcome, duration in seconds, sentiment (-1 to 1), the AI-generated summary, the fields the agent extracted and the contact's phone number. ...", "description_es": "Se envía cuando termina una llamada en la que hubo conversación. Incluye el resultado, la duración en segundos, el sentimiento (de -1 a 1), el resumen generado por IA, los datos que extrajo el agente y el número de teléfono del contacto. ...", "opt_in_only": false, "example": { "agent_id": "3c59dc04-8f1a-4e2b-9d6c-7a1b2c3d4e5f", "call_id": "1679091c-5a88-4faf-8b3a-6c5d4e3f2a10", "campaign_id": "a87ff679-a2f3-4e71-8c9e-1b2c3d4e5f60", "contact_id": "e4da3b7f-bbce-4345-9d77-2f1e0c9b8a70", "data_collection": { "email": "laura.gomez@example.com", "preferred_day": "jueves" }, "duration": 184, "kpi_data": { "appointments_booked": 1 }, "outcome": "appointment_booked", "phone_number": "+573001234567", "sentiment_score": 0.62, "summary": "La clienta pidió una cita para el jueves a las 10 a. m. y confirmó su correo." } }, { "type": "audit.log_recorded", "category": "audit", "description_en": "Sent for each audited action that a person or an API key performs in the workspace, for SIEM ingestion. ... High volume: not covered by the wildcard.", "description_es": "Se envía por cada acción auditada que una persona o una clave de API realiza en el espacio de trabajo, para su ingesta en un SIEM. ... Alto volumen: el comodín no lo incluye.", "opt_in_only": true, "example": { "action": "update", "audit_id": "1f0e3dad-9990-4a1b-8c2d-3e4f5a6b7c80", "changes": { "body": { "name": "Sofía - Recepción" } }, "ip_address": "181.52.10.4", "occurred_at": "2026-09-27T21:04:05.000Z", "redacted_at": null, "redaction_reason": null, "resource_id": "3c59dc04-8f1a-4e2b-9d6c-7a1b2c3d4e5f", "resource_type": "agent", "user_agent": { "browser": "Chrome", "device": "desktop", "os": "Windows" }, "user_id": "user_2abcDEF345ghiJKL678" } } ] } ``` **SDK Code** ```python Webhooks_getWebhooksEventTypes_example import requests url = "https://api.jelliu.co/api/webhooks/event-types" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Webhooks_getWebhooksEventTypes_example const url = 'https://api.jelliu.co/api/webhooks/event-types'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Webhooks_getWebhooksEventTypes_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.jelliu.co/api/webhooks/event-types" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Webhooks_getWebhooksEventTypes_example require 'uri' require 'net/http' url = URI("https://api.jelliu.co/api/webhooks/event-types") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Webhooks_getWebhooksEventTypes_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.jelliu.co/api/webhooks/event-types") .header("Authorization", "Bearer ") .asString(); ``` ```php Webhooks_getWebhooksEventTypes_example request('GET', 'https://api.jelliu.co/api/webhooks/event-types', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Webhooks_getWebhooksEventTypes_example using RestSharp; var client = new RestClient("https://api.jelliu.co/api/webhooks/event-types"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Webhooks_getWebhooksEventTypes_example import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.jelliu.co/api/webhooks/event-types")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```