Pular para o conteúdo principal
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
webhooks
curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/webhooks" \
  -H "Authorization: Bearer talq_your_environment_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lifecycle Webhook",
    "webhook_url": "https://example.com/campaign-events",
    "events": ["campaign.started", "campaign.completed", "campaign_call.completed"],
    "include_call_events": false
  }'

{
  "success": true,
  "data": {
    "id": "webhook-uuid-1",
    "campaign_id": "campaign-uuid",
    "name": "Lifecycle Webhook",
    "events": ["campaign.started", "campaign.completed", "campaign_call.completed"],
    "enabled": true,
    "include_call_events": false,
    "created_at": "2024-01-15T15:00:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.talkover.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Criar Webhook da Campanha

Cria um webhook inscrito em eventos de ciclo de vida da campanha e por chamada de campanha.

​
Endpoint

POST /api/v1/campaigns/{campaign_id}/webhooks

​
Parâmetros de Caminho

​
campaign_id
string
obrigatório
UUID da campanha.

​
Cabeçalhos da Requisição

​
Authorization
string
obrigatório
Token Bearer. Formato: Bearer talq_your_environment_token_here
​
Content-Type
string
obrigatório
Deve ser definido como application/json

​
Corpo da Requisição

​
name
string
obrigatório
Nome do webhook. Máximo de 255 caracteres.
​
webhook_url
string
obrigatório
URL de entrega. Máximo de 500 caracteres.
​
events
array
obrigatório
Array de eventos inscritos. Mínimo de 1.
​
webhook_secret
string
Secret opcional de assinatura HMAC-SHA256. Máximo de 255 caracteres.
​
timeout
integer
Timeout da requisição em segundos. Faixa: 5–120. Padrão: 30.
​
max_retries
integer
Tentativas de retry em caso de falha. Faixa: 0–10. Padrão: 3.
​
enabled
boolean
Padrão: true.
​
http_method
string
Opções: POST, PUT, PATCH. Padrão: POST.
​
authorization_scheme
string
Opções: none, bearer, basic, api_key, custom. Padrão: none.
​
custom_headers
array
Array de objetos {key, value}.
​
payload_templates
object
Sobrescritas de template por evento.
​
include_call_events
boolean
Quando true, também entrega eventos por chamada para chamadas desta campanha (além dos eventos de nível de campanha).

​
Exemplos

curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/webhooks" \
  -H "Authorization: Bearer talq_your_environment_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lifecycle Webhook",
    "webhook_url": "https://example.com/campaign-events",
    "events": ["campaign.started", "campaign.completed", "campaign_call.completed"],
    "include_call_events": false
  }'

​
Resposta

{
  "success": true,
  "data": {
    "id": "webhook-uuid-1",
    "campaign_id": "campaign-uuid",
    "name": "Lifecycle Webhook",
    "events": ["campaign.started", "campaign.completed", "campaign_call.completed"],
    "enabled": true,
    "include_call_events": false,
    "created_at": "2024-01-15T15:00:00Z"
  }
}