Ganchos de eventos

Os ganchos de eventos são webhooks de saída que disparam quando algo acontece no projeto, como a publicação de uma entrada ou uma transição de fluxo de trabalho. Cada gancho executa uma ação que envia uma solicitação HTTP para uma URL que você indica ou publica uma mensagem em um canal do Slack.

Use ganchos de eventos para integrar o Contismo a sistemas externos: invalidar caches, sincronizar dados com outras plataformas, disparar builds ou avisar a equipe no Slack.

Criar um gancho de eventos

1. Vá em Configurações → Ganchos de eventos.
2. Clique em Criar hook de eventos.
3. Digite um nome que identifique o que o gancho faz.
4. Escolha um Gatilho (veja a tabela abaixo).
5. Opcionalmente, limite o gancho a modelos de conteúdo específicos.
6. Escolha uma Ação: HTTP ou Slack.
7. Configure os detalhes da ação e salve.

Criar e gerenciar ganchos de eventos exige as permissões de webhook correspondentes no seu papel.

Gatilhos

Gatilho	Dispara quando
Entrada criada	Uma nova entrada é criada.
Entrada atualizada	Uma entrada existente é salva.
Entrada publicada	Uma entrada vai ao ar.
Entrada despublicada	Uma entrada no ar é retirada.
Entrada movida para a lixeira	Uma entrada é excluída (movida para a lixeira).
Entrada restaurada	Uma entrada da lixeira é restaurada.
Entrada excluída permanentemente	Uma entrada é removida de forma permanente da lixeira.
Transição de fluxo de trabalho	Uma entrada passa para um novo estado do fluxo de trabalho.

Você pode restringir um gancho a um ou mais modelos de conteúdo para que ele só dispare nas entradas correspondentes.

Ações HTTP

Uma ação HTTP envia uma solicitação para uma URL que você informa quando o gatilho dispara.

Configure:

• URL: o endpoint que recebe a solicitação.
• Método: POST, PUT ou PATCH.
• Cabeçalhos: cabeçalhos personalizados enviados com a solicitação. Marque valores sensíveis como segredo para armazená-los criptografados.
• Segredo de assinatura (opcional): quando definido, as solicitações incluem um cabeçalho X-EventHook-Signature com uma assinatura HMAC-SHA256 que o endpoint pode verificar.

O endpoint deve responder com um código de status de sucesso. Entregas com falha ficam registradas no registro de entregas do gancho.

Ações do Slack

Uma ação do Slack publica uma mensagem formatada em um canal do Slack quando o gatilho dispara.

Antes de usar uma ação do Slack:

1. Conecte o Slack ao projeto. Consulte Slack.
2. Ao criar o gancho de eventos, escolha Slack como ação e selecione um canal.

Canais privados

Em canais privados, convide o app do Contismo para o canal no Slack antes de selecioná-lo no gancho de eventos. O app precisa ser membro do canal para ver e publicar mensagens lá.

Registros de entrega

Cada gancho de eventos tem um registro de entregas com as tentativas recentes, tenham sido bem-sucedidas ou não. Na lista de ganchos de eventos, clique em Ver registros de um gancho para inspecionar entregas individuais.

Use os registros para depurar problemas de integração, como URLs incorretas, falhas de autenticação ou canais do Slack que não estão mais disponíveis.

Permissões

Os ganchos de eventos são gerenciados em Configurações → Desenvolvedores. Os membros da equipe precisam de capacidades de webhook para listar, criar, atualizar ou excluir ganchos. Ações do Slack também exigem que o Slack esteja conectado por alguém com a permissão Gerenciar integrações.

Relacionado

• Slack: conecte um workspace do Slack para as ações do Slack.