Passar para o conteúdo principal

Como cadastrar, editar, pausar e excluir um webhook

Gerencie os webhooks em Configurações > Integrações > Webhooks

C
Escrito por Cleverson Boff

Você gerencia seus webhooks em Configurações > Integrações > Webhooks. Na lista aparecem o nome, o endpoint, o status, os eventos e as entregas dos últimos 7 dias de cada webhook.

Cadastrar um webhook

  1. Clique em Novo webhook.

  2. Preencha o Endpoint: a URL HTTPS que vai receber os eventos, como https://seu-dominio.com/webhooks/omni. Endereços sem HTTPS não são aceitos.

  3. Se quiser, dê um nome ao webhook, como "ERP da loja", com até 40 caracteres. É esse nome que aparece na lista.

  4. Em Headers de autenticação, clique em Adicionar header e informe o nome e o valor. Por exemplo: nome Authorization e valor Bearer seu-token. Os headers são opcionais, mas recomendamos usar um token para o seu sistema saber que a chamada veio da OmniChat.

  5. Em Eventos, marque o que este endpoint deve receber. Os eventos ficam separados em Atendimentos e Campanhas, e só entregamos os marcados. Marque pelo menos um.

  6. Clique em Salvar webhook.

Para ver o que o seu endpoint vai receber, clique em Ver exemplo ao lado de cada evento. O exemplo mostra o JSON e explica cada campo, e você pode usar Copiar JSON para testar no seu sistema.

O bloco Como enviamos os eventos, no mesmo formulário, resume os requisitos do endpoint. Encaminhe para quem desenvolve a integração.

Editar um webhook

Na lista, clique em Editar no webhook. Você pode trocar o endpoint, o nome, os headers e os eventos. As mudanças valem para eventos novos. Eventos que já estavam na fila, inclusive os que estão em nova tentativa, ainda saem com a configuração anterior, o que pode levar alguns minutos. Por isso, corrigir o endpoint não recupera os eventos que já estavam falhando.

Os valores dos headers ficam ocultos. Use o ícone de olho para ver o valor antes de alterar.

Pausar um webhook

Para parar de receber eventos sem perder a configuração, abra o webhook, desligue a opção Ativo e salve. Na lista, ele passa a aparecer como Inativo.

A pausa vale na hora para eventos novos. Eventos que já estavam na fila no momento da pausa ainda são entregues. Para voltar a receber, ligue Ativo de novo. Os eventos que aconteceram enquanto o webhook estava pausado não são enviados depois.

Excluir um webhook

Na lista, clique em Excluir e confirme. Os eventos deixam de ser enviados para aquele endpoint, e essa ação não pode ser desfeita. Se você só quer parar por um tempo, prefira pausar.

Se aparecer Não foi possível excluir o webhook, a mensagem logo abaixo explica o motivo.

Respondeu à sua pergunta?