Webhook
API para disparar automações remotamente via HTTP
O Webhook permite que sistemas externos disparem a execução de automações em Runners específicos via chamada HTTP. O servidor se comunica com o Runner em tempo real através do WebSocket Gateway.
Fluxo de Execução
Sistema Externo → API (POST /api/automation/run)
↓
Valida API Key
↓
Verifica Runner no banco
↓
Verifica se Runner está online (Gateway)
↓
Envia comando via WebSocket Gateway
↓
Runner recebe e executa a automaçãoPré-requisitos
- Runner registrado e online (conectado ao WebSocket Gateway)
- API Key válida associada à organização
- Servidor conectado ao Gateway WebSocket
A resposta confirma apenas que o comando foi enviado ao Runner. Ela não garante que a automação foi executada com sucesso.
Endpoints
Authorization
apiKey x-api-key<token>
Chave de API para autenticação
In: header
Path Parameters
runnerId*string
ID do Runner que irá executar a automação
automationId*string
ID da automação a ser executada
Request Body
application/json
Dados opcionais enviados como input para a automação
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.runner.dclick.com.br/api/automation/run/42/minha-automacao" \ -H "Content-Type: application/json" \ -d '{}'{
"message": "Automation run request sent successfully",
"status": "success",
"code": "AUTOMATION_RUN_INITIATED",
"data": {
"runnerId": "string",
"automationId": "string",
"inputData": {}
}
}{
"error": "string",
"code": "string",
"details": [
{}
]
}{
"error": "string",
"code": "string"
}{
"error": "Socket client is not connected to gateway",
"code": "SOCKET_NOT_CONNECTED"
}