Webhooks de Agente
Criar Webhook
Criar uma nova configuração de webhook para um agente
POST
Visão Geral
Cria uma nova configuração de webhook para um agente. Webhooks permitem receber notificações em tempo real quando eventos específicos ocorrem durante as chamadas.Endpoint
string
obrigatório
UUID do agente
Requisição
Resposta
boolean
Indica se o webhook foi criado com sucesso
string
Mensagem de sucesso
object
Objeto do webhook criado
string
Identificador único do webhook
string
UUID do agente ao qual este webhook pertence
string
Nome do webhook
string
URL do webhook
array
Array de tipos de evento configurados
integer
Timeout da requisição em segundos
integer
Tentativas máximas de retry
boolean
Se o webhook está ativo
string
Timestamp ISO 8601 quando o webhook foi criado
string
Timestamp ISO 8601 quando o webhook foi atualizado pela última vez
integer
Número de eventos configurados para este webhook
string
Status atual do webhook
Respostas de erro
Regras de validação
- name: Obrigatório, string, máximo de 255 caracteres
- webhook_url: Obrigatório, URL válida, máximo de 500 caracteres
- webhook_secret: Opcional, string, máximo de 255 caracteres
- events: Obrigatório, array com mínimo de 1 evento, cada evento deve estar na lista de eventos disponíveis
- timeout: Opcional, inteiro entre 5-120 segundos (padrão: 30)
- max_retries: Opcional, inteiro entre 0-10 (padrão: 3)
- enabled: Opcional, booleano (padrão: true)
Observações importantes
- Operações de webhook limpam automaticamente o cache do agente para efeito imediato
- Use endpoints HTTPS para URLs de webhook em produção
- Implemente verificação adequada de assinatura usando o webhook secret para segurança
- Teste seu endpoint de webhook antes de entrar em produção usando o endpoint de teste
Endpoints relacionados
- Listar Webhooks do Agente - Obter todos os webhooks de um agente
- Obter Detalhes do Webhook - Recuperar informações de um webhook específico
- Atualizar Webhook - Modificar a configuração do webhook
- Excluir Webhook - Remover a configuração do webhook
- Alternar Status do Webhook - Habilitar/desabilitar webhook
- Testar Webhook - Enviar payload de teste para verificar conectividade