Como usar webhooks na Akece

Os webhooks permitem que você integre a Akece com outras plataformas e sistemas externos. Sempre que uma ação ocorre — como o envio de uma nova mensagem ou a criação de uma conversa — um webhook pode ser disparado automaticamente, enviando os dados relevantes em tempo real para uma URL definida por você.

Você pode criar múltiplos webhooks em uma mesma conta, cada um com diferentes destinos e eventos monitorados.

Como adicionar um webhook

Passo 1 – Acesse as configurações

1. Vá em Configurações → Integrações → Webhooks.

2. Clique no botão Configurar.

Passo 2 – Crie um novo webhook

1. Clique em Adicionar novo webhook.

2. Insira a URL que deve receber as requisições POST.

3. Selecione os eventos que você deseja monitorar. Assim, apenas ações relevantes para você serão enviadas.

A Akece enviará uma requisição POST com um payload em JSON sempre que um dos eventos selecionados ocorrer.

Exemplo de payload de mensagem

{
  "event": "message_created",
  "id": "1",
  "content": "Oi",
  "created_at": "2024-04-07 10:00:00 UTC",
  "message_type": "incoming",
  "content_type": "text",
  "content_attributes": {},
  "sender": {
    "id": "1",
    "name": "Atendente",
    "email": "[email protected]"
  },
  "contact": {
    "id": "2",
    "name": "João Silva"
  },
  "conversation": {
    "display_id": "1234",
    "additional_attributes": {
      "browser": {
        "device_name": "iPhone",
        "browser_name": "Safari",
        "platform_name": "iOS",
        "browser_version": "15.4",
        "platform_version": "15"
      },
      "referer": "https://meusite.com"
    }
  },
  "account": {
    "id": "1",
    "name": "Minha Empresa"
  }
}

Eventos disponíveis

Você pode escolher entre os seguintes eventos ao configurar um webhook na Akece:

• conversation_created
  Disparado quando uma nova conversa é iniciada na conta.

• conversation_updated
  Disparado sempre que há uma alteração em qualquer atributo de uma conversa.

• conversation_status_changed
  Disparado quando o status da conversa é alterado (por exemplo, de "aberta" para "resolvida").

• message_created
  Disparado sempre que uma nova mensagem é enviada em uma conversa.

• message_updated
  Disparado quando uma mensagem existente é editada.

• webwidget_triggered
  Disparado quando um visitante abre o widget de chat no site.

Cada evento envia um payload com dados específicos relacionados ao tipo de ação e aos objetos envolvidos, como contato, atendente, conversa, mensagem, entre outros. Esses dados podem ser utilizados para automatizações, integrações com CRMs, notificações e muito mais.

Estrutura dos objetos enviados

Os principais objetos que podem ser incluídos nos payloads são:

• Account (conta)

• Inbox (caixa de entrada)

• Contact (contato)

• User (atendente)

• Conversation (conversa)

• Message (mensagem)

Cada objeto contém seus próprios atributos — como id, nome, email, status, entre outros — que ajudam você a identificar e processar os dados do evento com precisão.

Com os webhooks da Akece, você pode automatizar tarefas, alimentar sistemas externos com dados em tempo real e criar fluxos personalizados para o seu negócio.

Se tiver dúvidas sobre como configurar ou usar os webhooks, fale com o nosso time:
📩 [email protected] | 📱 @akece.ai

Próximo passo: explore a API da Akece para ampliar ainda mais suas integrações!