API e webhooks
Os seus sistemas podem conversar com o Dashboard Mágico de duas formas:
- pela API, que lê e altera os dados da organização — usuários do portal, entidades, conectores, páginas e o resto do que o dashboard mostra;
- por webhooks, que avisam o seu sistema na hora em que algo acontece, sem que ele precise perguntar.
Tudo isso fica em Sistema › API (/dashboard/api), em quatro abas:
| Aba | O que você encontra |
|---|---|
| Tokens de API | Onde criar o token que as suas aplicações usam na API. Veja Tokens de API. |
| Webhooks | Os endpoints que recebem os eventos e o histórico de cada envio. Veja Webhooks e Entregas. |
| Limites de Requisição | Quantas requisições a API aceita. Veja Rate limiting. |
| Documentação | Atalhos para a documentação da API, a especificação OpenAPI, a coleção Postman e os exemplos de payload de webhook. |
Para abrir essa tela, a sua função precisa ter acesso aos tokens de API (veja Membros). Sem ele, o dashboard mostra um aviso de acesso negado.
Workspace nas chamadas da API
O token identifica a organização. O workspace vai no header X-Workspace-Id, com o ID que aparece em cada cartão de Sistema › Workspaces. Enquanto a organização tem um só workspace, o header é opcional; a partir do segundo, toda chamada precisa dizer em qual workspace age. Veja Organização e workspaces.
Nesta seção
- Tokens de API — como as suas aplicações se autenticam na API.
- Webhooks — cadastrar, testar e proteger os endpoints que recebem eventos.
- Entregas — acompanhar cada envio e reenviar o que falhou.
- Eventos de webhook — o formato do payload e os eventos disponíveis.
- Rate limiting — os limites de requisições e o que acontece quando você passa deles.
A referência completa dos endpoints está na seção API do menu superior (comece pela introdução), e as ferramentas para agentes de IA, na seção MCP.