Pular para o conteúdo principal
PATCH
/
api
/
v1
/
agents
/
{agent_id}
/
webhooks
/
{webhook_id}
/
toggle
curl -X PATCH \
  'https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/toggle' \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "message": "Webhook habilitado",
  "data": {
    "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:50:15.000000Z",
    "events_count": 2,
    "status": "active"
  }
}

​
Visão Geral

Alterna o status habilitado/desabilitado de um webhook. Isso é útil para parar temporariamente as notificações de webhook sem excluir a configuração.

​
Endpoint

​
agent_id
string
obrigatório
UUID do Agente
​
webhook_id
string
obrigatório
UUID do Webhook

​
Requisição

curl -X PATCH \
  'https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/toggle' \
  -H 'Authorization: Bearer YOUR_TOKEN'

​
Resposta

​
success
boolean
Indica se o status do webhook foi alternado com sucesso
​
message
string
Mensagem de status indicando se o webhook foi habilitado ou desabilitado
​
data
object
Objeto do webhook atualizado com novo status habilitado
​
data.id
string
Identificador único do webhook
​
data.agent_id
string
UUID do agente ao qual este webhook pertence
​
data.name
string
Nome do webhook
​
data.webhook_url
string
URL do webhook
​
data.events
array
Array de tipos de eventos configurados
​
data.timeout
integer
Timeout da requisição em segundos
​
data.max_retries
integer
Máximo de tentativas de nova tentativa
​
data.enabled
boolean
Novo status do webhook (alternado do estado anterior)
​
data.created_at
string
Timestamp ISO 8601 quando o webhook foi criado
​
data.updated_at
string
Timestamp ISO 8601 quando o webhook foi atualizado pela última vez
​
data.events_count
integer
Número de eventos configurados para este webhook
​
data.status
string
Status atual do webhook
{
  "success": true,
  "message": "Webhook habilitado",
  "data": {
    "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:50:15.000000Z",
    "events_count": 2,
    "status": "active"
  }
}

{
  "success": true,
  "message": "Webhook desabilitado",
  "data": {
    "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": false,
    "created_at": "2025-09-03T23:19:51.000000Z",
    "updated_at": "2025-09-03T23:50:15.000000Z",
    "events_count": 2,
    "status": "disabled"
  }
}

​
Respostas de erro

{
  "message": "Token Bearer ausente"
}

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

{
  "success": false,
  "message": "Webhook não encontrado."
}

​
Notas Importantes

  • Este endpoint alterna o status atual habilitado/desabilitado do webhook
  • Webhooks desabilitados não receberão nenhum evento até serem re-habilitados
  • Operações de webhook limpam automaticamente o cache do agente para efeito imediato
  • Use este endpoint para gerenciamento temporário de webhook sem perder a configuração

​
Endpoints relacionados