Pular para o conteúdo principal
GET
/
api
/
v1
/
agents
/
{agent_id}
/
webhooks
curl -X GET \
  'https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks' \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "data": {
    "webhooks": [
      {
        "id": "9fcafbf2-7593-44d6-8cd7-1b221beba62a",
        "agent_id": "9fbef0b7-8d4e-4a08-9207-66c22155721d",
        "name": "Meu Webhook",
        "webhook_url": "https://example.com/webhook",
        "events": ["event_phone_call_started", "event_phone_call_ended"],
        "timeout": 30,
        "max_retries": 3,
        "enabled": true,
        "created_at": "2025-09-03T23:19:51.000000Z",
        "updated_at": "2025-09-03T23:37:01.000000Z",
        "events_count": 2,
        "status": "active"
      }
    ],
    "available_events": {
      "event_phone_call_started": "Chamada telefônica iniciada",
      "event_phone_call_ended": "Chamada telefônica finalizada",
      "event_phone_call_did_not_connect": "Chamada telefônica falhou ao conectar",
      "event_phone_call_connected": "Conexão da chamada telefônica estabelecida",
      "event_phone_call_disconnected": "Conexão da chamada telefônica fechada",
      "event_phone_call_error": "Erro de conexão da chamada telefônica ocorreu",
      "event_participant_joined": "Participante entrou na chamada",
      "event_participant_left": "Participante saiu da chamada",
      "event_voicemail_detected": "Sistema de correio de voz detectado",
      "event_voicemail_message_left": "Mensagem deixada no correio de voz",
      "event_conversation_started": "Conversa humana iniciada",
      "event_conversation_ended": "Conversa humana finalizada",
      "event_action": "Agente executou uma ação",
      "event_action_failed": "Ação do agente falhou",
      "event_recording": "Evento de gravação da chamada",
      "event_connection_established": "Conexão da chamada estabelecida",
      "event_connection_closed": "Conexão da chamada fechada",
      "event_connection_error": "Erro de conexão da chamada ocorreu",
      "event_user_connected": "Usuário conectado à chamada",
      "event_user_disconnected": "Usuário desconectado da chamada",
      "event_client_connected": "Cliente conectado à chamada",
      "event_client_disconnected": "Cliente desconectado da chamada"
    }
  }
}

​
Visão Geral

Lista todos os webhooks configurados para um agente específico, incluindo seu status atual, eventos configurados e metadados.

​
Endpoint

​
agent_id
string
obrigatório
UUID do Agente

​
Requisição

curl -X GET \
  'https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks' \
  -H 'Authorization: Bearer YOUR_TOKEN'

​
Resposta

​
success
boolean
Indica se a requisição foi bem-sucedida
​
data
object
Dados de resposta contendo webhooks e eventos disponíveis
​
data.webhooks
array
Array de configurações de webhook para o agente
​
data.webhooks[].id
string
Identificador único do webhook
​
data.webhooks[].agent_id
string
UUID do agente ao qual este webhook pertence
​
data.webhooks[].name
string
Nome legível do webhook
​
data.webhooks[].webhook_url
string
URL onde os eventos do webhook serão enviados
​
data.webhooks[].events
array
Array de tipos de eventos que este webhook está configurado para receber
​
data.webhooks[].timeout
integer
Timeout da requisição em segundos (5-120)
​
data.webhooks[].max_retries
integer
Número máximo de tentativas de nova tentativa (0-10)
​
data.webhooks[].enabled
boolean
Se o webhook está atualmente ativo
​
data.webhooks[].created_at
string
Timestamp ISO 8601 quando o webhook foi criado
​
data.webhooks[].updated_at
string
Timestamp ISO 8601 quando o webhook foi atualizado pela última vez
​
data.webhooks[].events_count
integer
Número de eventos configurados para este webhook
​
data.webhooks[].status
string
Status atual do webhook (ativo, desabilitado, erro)
​
data.available_events
object
Objeto contendo todos os eventos de webhook disponíveis e suas descrições
{
  "success": true,
  "data": {
    "webhooks": [
      {
        "id": "9fcafbf2-7593-44d6-8cd7-1b221beba62a",
        "agent_id": "9fbef0b7-8d4e-4a08-9207-66c22155721d",
        "name": "Meu Webhook",
        "webhook_url": "https://example.com/webhook",
        "events": ["event_phone_call_started", "event_phone_call_ended"],
        "timeout": 30,
        "max_retries": 3,
        "enabled": true,
        "created_at": "2025-09-03T23:19:51.000000Z",
        "updated_at": "2025-09-03T23:37:01.000000Z",
        "events_count": 2,
        "status": "active"
      }
    ],
    "available_events": {
      "event_phone_call_started": "Chamada telefônica iniciada",
      "event_phone_call_ended": "Chamada telefônica finalizada",
      "event_phone_call_did_not_connect": "Chamada telefônica falhou ao conectar",
      "event_phone_call_connected": "Conexão da chamada telefônica estabelecida",
      "event_phone_call_disconnected": "Conexão da chamada telefônica fechada",
      "event_phone_call_error": "Erro de conexão da chamada telefônica ocorreu",
      "event_participant_joined": "Participante entrou na chamada",
      "event_participant_left": "Participante saiu da chamada",
      "event_voicemail_detected": "Sistema de correio de voz detectado",
      "event_voicemail_message_left": "Mensagem deixada no correio de voz",
      "event_conversation_started": "Conversa humana iniciada",
      "event_conversation_ended": "Conversa humana finalizada",
      "event_action": "Agente executou uma ação",
      "event_action_failed": "Ação do agente falhou",
      "event_recording": "Evento de gravação da chamada",
      "event_connection_established": "Conexão da chamada estabelecida",
      "event_connection_closed": "Conexão da chamada fechada",
      "event_connection_error": "Erro de conexão da chamada ocorreu",
      "event_user_connected": "Usuário conectado à chamada",
      "event_user_disconnected": "Usuário desconectado da chamada",
      "event_client_connected": "Cliente conectado à chamada",
      "event_client_disconnected": "Cliente desconectado da chamada"
    }
  }
}

​
Respostas de erro

{
  "message": "Token Bearer ausente"
}

{
  "success": false,
  "message": "Agente não encontrado neste ambiente."
}

​
Endpoints relacionados