API e webhooks

Conecte a Ciarem aos seus próprios sistemas com uma API e webhooks

Gerencie contatos e a configuração do seu CRM, leia conversas e envie modelos de WhatsApp pelo seu código. Os webhooks avisam seu servidor assim que um contato, uma conversa ou uma mensagem muda, assinados e com novas tentativas.

Começar teste grátis de 14 dias
  • Sem cartão de crédito. Cancele quando quiser.

Disponibilidade: O acesso à API e os webhooks estão incluídos no Growth (10 requisições por segundo) e no Scale (20 por segundo), e liberados durante o teste grátis de 14 dias (5 por segundo). O Solo não inclui.

Integrações que não se desencontram

  1. Nosso CRM e a Ciarem ficam diferentes, e alguém acerta tudo numa planilha.

    1. Os contatos são criados, lidos, atualizados e excluídos pela API, e os webhooks de contatos trazem o contato inteiro.

  2. Nosso sistema sabe quando um pedido é despachado, mas o WhatsApp é enviado à mão.

    2. Envie um modelo aprovado para um destinatário ou para cem numa única chamada e acompanhe o que aconteceu com cada um.

  3. Consultamos mudanças a cada poucos minutos e ainda perdemos coisas.

    3. Os webhooks enviam cada evento ao seu servidor em segundos e tentam de novo as falhas por até 3 dias.

Uma API REST para o seu CRM e o WhatsApp

As chaves pertencem à sua organização, não a uma pessoa, então continuam funcionando quando alguém sai da equipe. A referência de cada endpoint é gerada a partir do contrato em produção, e as mudanças são aditivas e ficam no changelog.

  • Contatos: criar, ler, atualizar e excluir
  • CRM: propriedades personalizadas e etapas do funil
  • Conversas: ler o histórico de mensagens
  • Modelos de WhatsApp: criar, ver o que um envio precisa e enviar
  • Campanhas: acompanhar cada destinatário, ou cancelar

Webhooks no momento em que algo muda

Informe uma URL HTTPS, escolha os eventos que importam ou deixe ativado Enviar todos os eventos, e cada evento chega como um POST em segundos. Os eventos de contatos trazem o contato inteiro, então a maioria das integrações nem precisa consultar de volta.

  • Contatos criados, atualizados, excluídos ou mesclados
  • Mudanças de etapa do funil e de responsável
  • Conversas criadas, atribuídas e encerradas
  • Cada mensagem recebida de um cliente
  • Formulários de WhatsApp enviados, com as respostas

Assinados, reenviados e registrados

Cada requisição traz um cabeçalho Ciarem-Signature que você confere com o segredo de assinatura do endpoint. Uma entrega com falha é tentada de novo com esperas cada vez maiores por até 3 dias, cada tentativa fica no registro de entregas por 30 dias, e você pode reenviar uma entrega ou disparar um evento de teste quando quiser.

Feita para tentar de novo sem risco

Cada resposta traz seu limite de requisições nos cabeçalhos, para você regular o ritmo sem contar chamadas. Os envios de modelos aceitam um Idempotency-Key, então uma nova tentativa depois de um timeout nunca envia duas vezes, e uma chamada de envio conta como uma requisição, com um destinatário ou cem.

Como começar

Comece a construir

  1. 01

    Crie uma chave de API

    Um administrador abre Configurações, depois Chaves de API. Copie o segredo quando aparecer: a Ciarem guarda só um hash e mostra uma única vez.

  2. 02

    Adicione um endpoint de webhook

    Em Configurações, depois Webhooks, clique em Adicionar endpoint, cole sua URL HTTPS, escolha os eventos e guarde o segredo de assinatura.

  3. 03

    Envie um evento de teste

    Abra o endpoint, escolha um evento em Evento de teste e clique em Enviar evento de teste. A Ciarem mostra o que seu servidor respondeu.

Perguntas frequentes

O Growth, com 10 requisições por segundo, e o Scale, com 20. Ela fica liberada durante o teste grátis de 14 dias com 5 por segundo, para você construir antes de pagar. O Solo não inclui.

Sim, modelos de WhatsApp aprovados, para um destinatário ou até cem numa única chamada. Depois você acompanha o que aconteceu com cada destinatário.

Não. Os webhooks fazem parte do acesso à API no Growth, no Scale e no teste, com até 10 endpoints por organização.

Cada requisição é assinada no cabeçalho Ciarem-Signature com o segredo do seu endpoint, que começa com whsec_. Verifique antes de confiar no conteúdo.

As entregas com falha são tentadas de novo com esperas crescentes por até 3 dias, com o mesmo id de evento. Um endpoint em que todas as entregas falham por 3 dias seguidos é desativado até você ativá-lo de novo.

Na central de ajuda da Ciarem, em Referência da API. Cada endpoint é gerado a partir do contrato em produção, então o que você lê é o que a API entrega.

Recursos relacionados

Seu próximo cliente já escreveu para você.

Teste a Ciarem grátis por 14 dias e veja como ela responde com as suas informações antes que os seus clientes vejam.

Começar teste grátis de 14 dias
  • Sem cartão de crédito. Cancele quando quiser.