Webhooks

Desenvolvedor

O que são Webhooks?

Webhooks são URLs que recebem requisições HTTP POST de sistemas externos quando determinados eventos ocorrem. No Prodgy, os webhooks podem ser usados para:

Disparar agentes automaticamente com base em eventos externos
Receber notificações de ferramentas integradas (Git, DevOps, comunicadores)
Integrar sistemas que precisam enviar dados ao Prodgy em tempo real

Endpoint de Webhook

Os webhooks do Prodgy utilizam caminhos personalizados:

POST /api/webhook/{caminho_personalizado}
Content-Type: application/json

{
  "event": "tipo_do_evento",
  "data": { }
}

O caminho_personalizado e definido durante a configuração do webhook e serve como identificador único.

Formato da Requisição

Campo	Tipo	Descrição
Content-Type	Header	`application/json`
Método	HTTP	`POST`
Body	JSON	Payload do evento com dados estruturados

Exemplo de Payload

{
  "event": "commit.pushed",
  "repository": "meu-projeto",
  "branch": "main",
  "author": "dev@exemplo.com",
  "timestamp": "2026-03-05T14:30:00Z",
  "data": {
    "commit_id": "abc123",
    "message": "feat: nova funcionalidade"
  }
}

Formato da Resposta

Sucesso

{
  "success": true,
  "message": "Webhook processed successfully",
  "data": { }
}

Erro

{
  "success": false,
  "message": "Descrição do erro"
}

Códigos HTTP

Código	Descrição
200	Webhook processado com sucesso
400	Payload inválido ou mal formatado
404	Caminho de webhook não encontrado
500	Erro interno ao processar o webhook

Webhooks de Comunicadores

O Prodgy recebe webhooks de plataformas de comunicação para integração com o chat:

Slack / Google Chat

POST /api/communicator/webhook/{integration_base_id}
Content-Type: application/json

Microsoft Teams (Bot Framework)

POST /api/communicator/botframework/{integration_base_id}/messages
Content-Type: application/json

Esses endpoints são configurados automaticamente ao instalar integrações de comunicadores e não requerem configuração manual.

Boas Práticas

Valide os dados recebidos antes de processar — nunca confie cegamente no payload
Responda rapidamente — retorne HTTP 200 o mais rápido possível e processe assincronamente se necessário
Implemente retentativas — configure o sistema que envia webhooks para retentar em caso de falha (5xx)
Use HTTPS em produção para proteger os dados transmitidos
Monitore os logs para identificar falhas e eventos não processados