Webhooks

1 função do TermoIntranetAPI para webhooks.

// npm install termo_core --save-exact
import * as intranet from "termo_core/intranet";
// ou: import { intranet } from "termo_core";
FunçãoRotaO que faz
receber_evento_termo_webhook_webhooksPOST /webhooks/termowebhookRecebe os eventos entregues pelo TermoWebhook

receber_evento_termo_webhook_webhooks

POST/webhooks/termowebhook Pública

Recebe os eventos entregues pelo TermoWebhook

Pública, sem token do usuário: quem chama é o TermoWebhook, o hub de eventos da Termotubos, e a entrega é conferida pela assinatura Ed25519 do hub (chave pública do hub, data dentro da tolerância e id deste aplicativo como destino). Hoje são aplicados colaborador.criado e colaborador.atualizado, nas versões 1 e 2, que cadastram e atualizam o colaborador e o acesso a partir do TermoAuth; evento repetido ou mais antigo que o último aplicado é descartado sem erro, e tipo desconhecido responde 200 sem fazer nada. A resposta não tem corpo; qualquer status fora de 2xx faz o hub reenviar.

function receber_evento_termo_webhook_webhooks(
  parametros: ParametrosDeReceberEventoTermoWebhookWebhooks,
  corpo_da_requisicao: tipos.EntregaDoEvento,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>
Exemplo
import { receber_evento_termo_webhook_webhooks } from "termo_core/intranet";

await receber_evento_termo_webhook_webhooks({ "X-TermoWebhook-Data": 1, "X-TermoWebhook-Chave": "...", "X-TermoWebhook-Assinatura": "..." }, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<void> · Rust: Result<(), ErroAoChamarServico> · sem corpo na resposta.

Tipos

Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.

EntregaDoEvento

import type { EntregaDoEvento } from "termo_core/intranet";

export interface EntregaDoEvento {
  dados: Record<string, unknown>;
  entidade_id: string;
  id: string;
  ocorrido_em: string;
  publicador: string;
  recebido_em: string;
  tipo: string;
  versao: number;
}

Nesta página