DocumentaciónAjuda

Rotacionar ou desativar o webhook

Gere uma nova URL e um novo segredo se o segredo foi perdido ou exposto, ou desative o webhook para deixar de receber eventos.

Nesta página

Rotacionar o webhook substitui a URL e o segredo por novos: os anteriores deixam de funcionar na hora. Desativá-lo faz com que a URL deixe de aceitar eventos, sem apagar a integração nem seus eventos.

Antes de começar

  • Você precisa do papel Administrador. Com outro papel, esses botões não aparecem no cartão.

  • Combine com quem administra o sistema externo: depois de rotacionar, será preciso configurá-lo com os novos dados.

Rotacionar o webhook

Faça isso se você perdeu o segredo, se acha que mais alguém o conhece ou como parte da sua troca periódica de chaves.

  1. Acesse Configurações → Integrações.

  2. No cartão da integração, clique em Rotacionar.

  3. Confirme em Rotacionar o webhook de "…"? com Sim, rotacionar. O aviso lembra que o sistema externo deixará de poder enviar eventos até que você o configure com os novos dados.

  4. Abre-se Webhook ativado com a nova URL e o novo segredo. Copie-os e configure o seu sistema, como em Ativar o webhook e enviar eventos.

  5. Clique em Já copiei, fechar e, em Você já copiou o segredo?, confirme com Sim, fechar.

Entre a rotação e a reconfiguração do sistema externo, os eventos dele são rejeitados e não ficam registrados. Deixe a mudança pronta no outro sistema antes de rotacionar.

Desativar o webhook

Faça isso quando deixar de usar o sistema ou quiser cortar o envio de eventos imediatamente.

  1. No cartão da integração, clique no botão Desativar webhook (ao lado de Rotacionar).

  2. Confirme em Desativar o webhook de "…"? com Sim, desativar. O aviso lembra que você poderá ativá-lo novamente depois, com um novo segredo.

Você verá Webhook desativado. e o campo Webhook do cartão dirá Desativado.

Ativá-lo novamente

Clique em Webhook no cartão. Uma nova URL e um novo segredo são gerados imediatamente e abre-se Webhook ativado: a URL e o segredo anteriores não são recuperados.

Se você só quer deixar de receber eventos por um tempo e manter a mesma URL e o mesmo segredo, edite a integração e mude o Status para Pausada. Veja Editar, pausar ou excluir uma integração.

O que acontece depois

Os eventos que já chegaram são mantidos em Eventos recebidos. Enquanto o webhook estiver desativado, os envios do sistema externo são rejeitados.

Relacionado

Pesquisar em SofIA Gestão

Digite pelo menos 2 letras para pesquisar em SofIA Gestão.

↑↓ navegar · Enter abrir · Esc fechar