Public API (OpenAPI)
Review Documentación API, authenticate with an API key, and use a plan with useExternalApi.
Where it is
Go to Administración → Configuración de la empresa (/company-settings) and open the Documentación API tab.
The tab is available depending on the tenant (administrator schema / OpenAPI enabled). External API use also depends on the plan (useExternalApi).
Authentication
- Get the company API key (external integrations section on the Empresa tab, or the copy button in the documentation when visible).
- Send on every request:
Authorization: Bearer <api_key>Do not use x-external-secret or widget domain validation: that authentication is different from the web chat.
What it allows
The on-screen documentation describes how to query and update leads and contacts from external systems (the reverse path of webhooks).
Important: updates made through this API do not fire webhooks back; the HTTP response is the confirmation.
Relation to webhooks
| Webhooks | Documentación API | |
|---|---|---|
| Tab | Webhooks | Documentación API |
| Direction | whapi → your system | your system → whapi |
| Auth | Signature secret on deliveries | Bearer API key |
Configure both in Configuración de la empresa depending on whether you want to receive notifications, push changes, or both.