Configuração de Webhooks

Os webhooks permitem que você receba notificações automáticas sempre que eventos específicos ocorrem. Abaixo, você encontra mais informações sobre cada evento.

Configurando Webhooks

1. No painel, vá até Webhooks.

2. Clique em + Novo Webhook e insira o nome e a URL do seu servidor.

3. Escolha os eventos que deseja monitorar.

Atualmente, suportamos os seguintes eventos para chamadas: created e ended.

1. Evento created

O evento created é disparado sempre que uma nova chamada é criada no sistema. Esse evento é útil para iniciar processos automatizados, como notificações para usuários ou inicializações de integrações.

Exemplo de Payload

{
  "event": "call.created",
  "call": {
    "id": "123",
    "status": "pending",
    "created": "2025-02-03T12:00:00Z",
    "started": null,
    "ended": null,
    "project": {
      "id": "456"
    }
  },
  "secret": "your-webhook-secret"
}

2. Evento ended

O evento ended é disparado quando uma chamada é encerrada. Ele pode ser usado para registrar informações sobre a duração da chamada, finalizar processos ou gerar relatórios.

Exemplo de Payload

{
  "event": "call.ended",
  "call": {
    "id": "123",
    "status": "completed",
    "created": "2025-02-03T12:00:00Z",
    "started": "2025-02-03T12:05:00Z",
    "ended": "2025-02-03T12:30:00Z",
    "project": {
      "id": "456"
    }
  },
}

Descrição dos Campos

• event: Indica o tipo do evento (call.created ou call.ended).

• call: Contém os detalhes da chamada.

  • id: Identificador único da chamada.

  • status: Estado atual da chamada (e.g., pending, completed).

  • created: Data e hora em que a chamada foi criada.

  • started: Data e hora em que a chamada foi iniciada (somente para call.ended).

  • ended: Data e hora em que a chamada foi encerrada (somente para call.ended).

  • project.id: Identificador do projeto associado.

Configure a URL do webhook na plataforma, associando-a ao seu projeto. Crie um endpoint HTTP seguro para receber as requisições do webhook.

Segurança e Controle

Implementar boas práticas de segurança é crucial para garantir que sua aplicação lide adequadamente com eventos externos. Aqui estão algumas considerações importantes:

• Verificação de IPs: Considere implementar listas de permissões para garantir que apenas IPs confiáveis possam enviar eventos para seu sistema.

• Proteção contra Ataques: Esteja atento a possíveis ataques, como ataques de repetição, e implemente medidas como timestamps ou nonces para se proteger contra eles.