Webhooks

Os webhooks da Zardio permitem que você integre seus sistemas externos e dispare automações via WhatsApp de forma programática. Com eles, você pode iniciar fluxos de automação automaticamente quando eventos acontecem no seu CRM, e-commerce ou qualquer outro sistema.

Visão Geral

Webhooks são URLs únicas geradas pela Zardio que permitem disparar fluxos de automação a partir de sistemas externos. Quando você faz uma requisição HTTP para essa URL, a Zardio automaticamente executa o fluxo configurado, enviando mensagens pelo WhatsApp para o contato especificado.

Para que servem?

Os webhooks são ideais para automatizar comunicações baseadas em eventos do seu negócio:

Exemplo Prático

Imagine que você tem um CRM e deseja enviar uma mensagem de boas-vindas personalizada para cada novo cliente cadastrado:

1. Você cria um fluxo de automação na Zardio com a mensagem de boas-vindas
2. Cria um webhook vinculado a esse fluxo
3. No seu CRM, configura para fazer uma requisição POST para a URL do webhook sempre que um novo cliente for cadastrado
4. O cliente recebe automaticamente a mensagem pelo WhatsApp

{
  "phone": "5511999999999",
  "contextData": {
    "nome": "João Silva",
    "empresa": "Tech Solutions"
  }
}

Com isso, seu fluxo pode usar as variáveis {{nome}} e {{empresa}} para personalizar a mensagem.

Criando um Webhook

Siga os passos abaixo para criar um webhook na plataforma Zardio.

Passo 1: Acesse a página de Webhooks

Na barra lateral da Zardio, clique em Webhooks para acessar a página de gerenciamento.

Passo 2: Clique em "Novo Webhook"

Na página de webhooks, clique no botão Novo Webhook no canto superior direito.

Passo 3: Preencha as informações

Um modal será exibido para você configurar o webhook:

Passo 4: Clique em "Criar"

Após preencher as informações, clique no botão Criar. O webhook será criado e você verá a URL gerada.

Passo 5: Copie a URL do Webhook

O webhook criado aparecerá na lista. Clique no ícone de copiar ao lado da URL para copiá-la para a área de transferência.

Criando sua Chave de API

Para disparar webhooks via API, você precisa de uma API Key. Siga os passos abaixo para gerar sua chave.

Passo 1: Acesse seu Perfil

Na barra lateral da Zardio, clique em Perfil para acessar as configurações da sua conta.

Passo 2: Gere uma nova API Key

Role a página até a seção API Keys e clique no botão Gerar Nova API Key.

Passo 3: Copie sua API Key

Um modal será exibido com sua nova API Key. Clique no botão Copiar API Key para copiá-la para a área de transferência.

Disparar um Webhook

curl -X POST https://api.zardio.com/webhooks/call/exemple \
  -H "Content-Type: application/json" \
  -H "x-api-key: SUA_API_KEY" \
  -d '{
    "phone": "5511999999999"
  }'

{
  "success": true,
  "message": "Flow started"
}

Exemplo Completo com Dados Personalizados

{
  "contextData": {
    "nome": "Maria",
    "pedido": "12345"
  }
}

curl -X POST https://api.zardio.com/webhooks/call/exemple \
  -H "Content-Type: application/json" \
  -H "x-api-key: SUA_API_KEY" \
  -d '{
    "phone": "5511999999999",
    "behavior": "CANCEL_AND_START",
    "scheduledAt": "2024-12-25 10:00",
    "contextData": {
      "nome": "João Silva",
      "email": "joao@email.com",
      "pedido": "12345",
      "valor": 149.90
    }
  }'

{
  "success": true,
  "message": "Flow started"
}

Respostas de Erro

A API retorna diferentes códigos de status HTTP dependendo do resultado da requisição:

{
  "statusCode": 404,
  "message": "Webhook não encontrado ou inativo"
}