Pular para o conteúdo principal

Webhooks

Um webhook faz o caminho inverso da chave de API: em vez de o seu sistema perguntar, o Noxus Core avisa quando algo acontece.

Acesse Integrações → API → Webhooks.


Criar

  1. Clique em Novo webhook
  2. Informe a URL que vai receber (precisa ser HTTPS e responder rápido)
  3. Marque os eventos que interessam
  4. Salve

O segredo aparece na criação. Guarde: é ele que valida a assinatura dos eventos recebidos.


Eventos disponíveis

Chamados

EventoDispara quando
ticket.createdUm chamado é aberto
ticket.updatedQualquer campo do chamado muda
ticket.status_changedO estado muda
ticket.assignedO chamado é atribuído a alguém
ticket.message_createdUma mensagem é adicionada
ticket.resolvedO chamado é resolvido
ticket.reopenedUm chamado resolvido é reaberto

Clientes e CRM

EventoDispara quando
client.createdUm cliente é cadastrado
client.updatedO cadastro do cliente muda
opportunity.createdUma oportunidade entra no funil
opportunity.stage_changedA oportunidade muda de etapa
opportunity.wonA oportunidade é ganha
opportunity.lostA oportunidade é perdida

Apontamentos e financeiro

EventoDispara quando
time_entry.createdUma hora é apontada
invoice.createdUma fatura é emitida
invoice.paidUma fatura é paga

Validar a assinatura

Cada envio traz uma assinatura HMAC calculada com o segredo do webhook. Confira sempre. Sem essa conferência, qualquer um que descubra a sua URL pode mandar eventos falsos, e o seu sistema vai acreditar.

O procedimento é o de sempre: calcule o HMAC do corpo recebido usando o segredo, e compare com o cabeçalho de assinatura — usando comparação de tempo constante, não ==.


Testar antes de ligar

A aba Testador dispara um evento de exemplo para a sua URL, com trechos prontos em Node.js, Python e PHP. Use antes de ligar em produção — é mais rápido do que esperar um chamado de verdade acontecer para descobrir que o endpoint devolve 500.


Boas práticas

FaçaPor quê
Responda 2xx rápido e processe depoisEndpoint lento vira fila e atrasa os próximos eventos
Trate evento repetidoReenvio acontece; o processamento precisa ser idempotente
Não confie na ordemDois eventos quase simultâneos podem chegar fora de ordem
Registre o que chegouQuando algo não bater, o registro é a única forma de saber o que veio
URL de webhook não é segredo, o segredo é

Trate a URL como pública. A proteção é a assinatura HMAC — é ela que separa um evento legítimo de qualquer requisição que alguém mandar para o mesmo endereço.