Glossário de webhooks
Atores e conceitos centrais
Define os papéis e substantivos centrais de um sistema de webhooks: quem emite, quem recebe, qual URL é chamada e qual é o ponto de entrada na borda. Isso importa porque um vocabulário compartilhado deixa as responsabilidades claras, mantém as implementações consistentes e acelera a depuração.
Endpoint
| Propriedade | Descrição |
|---|---|
| Definição | URL HTTP que recebe webhooks. Exemplo: /webhooks/stripe (POST). |
| Por que importa | Determina autenticação, timeout, concorrência e alvos de roteamento. |
| Hookdeck | Depois de consumir um webhook em seu nome, a Hookdeck entrega o evento ao seu endpoint. Saiba mais |
| Também chamado de | listener, callback URL, webhook URL, destination URL, target URL, receiver URL, notification URL, callback endpoint, hook URL, push URL, event URL, subscriber URL, consumer endpoint, ingestion endpoint, reception point |
Saiba mais: O que são webhooks e como eles funcionam?
Termos relacionados: Forwarding · Signature (HMAC)
Webhook body
| Propriedade | Descrição |
|---|---|
| Definição | O payload da requisição HTTP contendo os dados do evento, normalmente em formato JSON. |
| Por que importa | O body carrega o evento de negócio propriamente dito (por exemplo, invoice.paid, user.created) que a sua aplicação consome. Fazer o parse e a validação corretamente é essencial para correção e segurança. |
| Hookdeck | A Hookdeck armazena o body bruto, o expõe nos logs e o encaminha inalterado para a sua aplicação, a menos que transformações sejam aplicadas. |
| Também chamado de | payload, message body, event payload, data body, webhook payload |
Termos relacionados: Webhook header · Webhook event · Schema drift
Webhook consumer
| Propriedade | Descrição |
|---|---|
| Definição | Sistema que recebe/processa webhooks. |
| Por que importa | É dono dos retries, da idempotência e dos efeitos downstream. |
| Hookdeck | A Hookdeck atua como o consumidor voltado ao público; a sua aplicação é o destino downstream. Use a URL da Hookdeck em vez do seu endpoint. |
| Também chamado de | destination, subscriber, receiver, listener, target system, recipient, handler, processor, event consumer, webhook receiver, ingestion system, sink, destination system |
Termos relacionados: Endpoint · Retry · Idempotency
Webhook event
| Propriedade | Descrição |
|---|---|
| Definição | Fato emitido por um provedor em um dado momento (payload imutável + metadados). |
| Por que importa | Base para idempotência, ordenação e contratos de schema. |
| Hookdeck | A Hookdeck preserva a identidade e os metadados do evento para rastreamento, deduplicação e replay. Saiba mais |
| Também chamado de | webhook, event, message, notification, trigger, signal, action, occurrence, incident, activity, operation, transaction, state change, update, alert, notification trigger, event notification, business event, system event, domain event |
Termos relacionados: Idempotency · Correlation ID · Schema drift
Webhook gateway
| Propriedade | Descrição |
|---|---|
| Definição | Ponto de entrada que oferece verificação, middlewares e roteamento de webhooks. |
| Por que importa | Tira a complexidade da borda do seu caminho e centraliza controle e visibilidade. |
| Hookdeck | Trate a Hookdeck como o seu event gateway gerenciado para webhooks. Saiba mais |
| Também chamado de | broker, edge, API gateway, edge gateway, message broker, event broker, ingestion gateway |
Leia o guia completo: O que é um webhook gateway?
Termos relacionados: Webhook proxy · Visibility layer · Routing
Webhook header
| Propriedade | Descrição |
|---|---|
| Definição | Headers HTTP anexados a uma requisição de webhook, carregando contexto como tipo de evento, assinatura, ID de entrega e retry count. |
| Por que importa | Headers são críticos para autenticação, rastreamento e interpretação do payload; headers ausentes ou adulterados podem quebrar a verificação ou a observabilidade. |
| Hookdeck | A Hookdeck preserva os headers do provedor, adiciona IDs de entrega e metadados, e os torna pesquisáveis no dashboard. |
| Também chamado de | request header, HTTP header, metadata header, webhook request header |
Termos relacionados: Webhook body · Signature (HMAC) · Correlation ID
Webhook metadata
| Propriedade | Descrição |
|---|---|
| Definição | Informação complementar anexada a uma entrega de webhook que não faz parte do body principal do evento (por exemplo, ID de entrega, retry count, timestamp). |
| Por que importa | Os metadados viabilizam checagens de idempotência, observabilidade e replay; é assim que você distingue retries ou rastreia um evento entre sistemas. |
| Hookdeck | A Hookdeck enriquece os webhooks com metadados de entrega (timestamps, status, contagem de tentativas) e os torna consultáveis para depuração ou replay. |
| Também chamado de | event metadata, delivery context, webhook context, delivery attributes |
Termos relacionados: Idempotency · Retry · Correlation ID
Webhook provider
| Propriedade | Descrição |
|---|---|
| Definição | Sistema que emite eventos de webhook. Exemplo: a Stripe publica invoice.paid. |
| Por que importa | Deixa claro quem assina as requisições e define o schema do payload. |
| Hookdeck | A Hookdeck não muda o seu provedor; ela consome os webhooks dele e normaliza a entrada. Saiba mais |
| Também chamado de | source, publisher, sender, producer, emitter, originator, broadcaster, source system, event producer, notification source, event source, webhook sender, dispatcher, initiator |
Termos relacionados: Webhook consumer · Endpoint · Signature (HMAC)
Tipos de evento e padrões
Descreve diferentes abordagens arquiteturais para o design de mensagens de webhook e de evento. Isso importa porque afeta a consistência dos dados, o uso da API, o tratamento de idempotência e a confiabilidade geral do sistema.
Command message
| Propriedade | Descrição |
|---|---|
| Definição | Uma mensagem que solicita a execução de um trabalho, imediatamente ou no futuro. Command messages usam nomes no imperativo (por exemplo, CreateAccount, SubmitPayment). |
| Por que importa | Comandos expressam intenção e disparam ações; entender a distinção entre comandos e eventos ajuda a esclarecer responsabilidades do sistema e o fluxo de mensagens. |
| Hookdeck | A Hookdeck pode rotear command messages para os handlers apropriados e dar visibilidade sobre o processamento desses comandos. |
| Também chamado de | request message, action message, imperative message |
Termos relacionados: Reply message · Webhook event · Routing
Event-Carried State Transfer (Fat Events)
| Propriedade | Descrição |
|---|---|
| Definição | Mensagens de evento que contêm toda a informação disponível no momento do evento, permitindo o processamento sem chamadas adicionais à API. O snapshot completo do estado vem embutido no payload do evento. Também conhecidos como "fat events". |
| Por que importa | Reduz chamadas de API e viabiliza sincronização de estado, replay de eventos e processamento offline, mas o payload pode estar desatualizado quando você o processar. Útil quando você precisa de um retrato dos dados no momento do evento, e não do estado atual. |
| Hookdeck | A Hookdeck preserva o payload completo do evento, independentemente do tamanho, e pode transformá-lo ou enriquecê-lo antes da entrega. |
| Também chamado de | fat events, full-state events, self-contained events, complete events, rich events |
Termos relacionados: Event Notification (Thin Events) · Webhook body · Idempotency
Event Notification (Thin Events)
| Propriedade | Descrição |
|---|---|
| Definição | Mensagens de evento que contêm informação mínima (normalmente apenas o tipo do evento e o ID do recurso) para notificar assinantes de que uma mudança de estado aconteceu. Os assinantes precisam buscar os dados mais recentes via API para processar o evento. Também conhecidos como "thin events". |
| Por que importa | Garante consistência dos dados ao forçar você a trabalhar com o estado mais recente do recurso, em vez de payloads possivelmente desatualizados; lida naturalmente com eventos fora de ordem e simplifica a idempotência. |
| Hookdeck | Os recursos de rate limiting e enfileiramento da Hookdeck ajudam você a implementar padrões de event notification em escala com segurança, sem estourar os rate limits da API. |
| Também chamado de | thin events, notification events, reference events, ID-only events, notification-only pattern |
Termos relacionados: Event-Carried State Transfer (Fat Events) · Webhook event · Idempotency · Fetch Before Process Pattern
Reply message
| Propriedade | Descrição |
|---|---|
| Definição | Uma mensagem que traz o resultado de uma command message. Reply messages costumam usar o sufixo Result ou Reply (por exemplo, CreateAccountResult, SubmitPaymentReply). |
| Por que importa | Viabiliza os padrões request-reply e fire-and-follow-up; é essencial para confirmar o processamento de comandos e comunicar resultados. |
| Hookdeck | A Hookdeck pode capturar e rotear reply messages, permitindo que você correlacione requisições com respostas. |
| Também chamado de | response message, result message, outcome message |
Termos relacionados: Command message · Acknowledgement · Correlation ID
Forwarding e proxy de borda
Aceitar webhooks na borda e repassá-los para destinos internos (incluindo o localhost durante o desenvolvimento). Isso importa porque esconde superfícies internas, centraliza controle e visibilidade e reduz o risco em produção.
Forwarding
| Propriedade | Descrição |
|---|---|
| Definição | Empurrar os webhooks recebidos para outra URL (localhost ou múltiplos serviços). |
| Por que importa | Esconde serviços internos; viabiliza fan-out e isolamento de ambientes. |
| Hookdeck | Encaminhe da Hookdeck para um ou muitos endpoints internos sem expô-los. |
| Também chamado de | relay, proxy, event relay, message forwarding, webhook relay, pass-through, re-routing |
Termos relacionados: Routing · Replay
Tunnel
| Propriedade | Descrição |
|---|---|
| Definição | URL pública temporária apontando para o localhost. |
| Por que importa | Permite desenvolvimento e testes locais sem expor a produção. |
| Hookdeck | Use tunnels em desenvolvimento pela CLI. Em produção, termine na Hookdeck, não no localhost. Saiba mais |
| Também chamado de | reverse tunnel, localhost tunnel, dev tunnel, HTTP tunnel, secure tunnel |
Termos relacionados: Sandbox · Forwarding
Webhook proxy
| Propriedade | Descrição |
|---|---|
| Definição | Componente que termina o HTTP de entrada e reenvia a requisição. |
| Por que importa | Adiciona visibilidade, controle e segurança na borda. |
| Hookdeck | A Hookdeck é o seu webhook proxy gerenciado, com logs e controle. |
| Também chamado de | gateway, edge proxy, webhook gateway, reverse proxy, middleware proxy, intermediary |
Termos relacionados: Visibility layer · Signature (HMAC)
Ingestão e controle de fluxo
Recepção confiável e modelagem do tráfego antes do processamento: aceitar, fazer buffer, enfileirar/transmitir e aplicar backpressure. Isso importa porque desacopla provedores de consumidores, absorve rajadas, preserva a durabilidade e mantém os sistemas downstream estáveis.
Backpressure
| Propriedade | Descrição |
|---|---|
| Definição | Mecanismo para desacelerar produtores quando os consumidores ficam para trás. |
| Por que importa | Evita sobrecarga e falhas em cascata. |
| Hookdeck | Use os rate limits da Hookdeck para segurar o fluxo com segurança. |
| Também chamado de | flow control, rate control, congestion control, throttle feedback |
Termos relacionados: Rate limiting · Burst control
Buffer
| Propriedade | Descrição |
|---|---|
| Definição | Armazenamento de curto prazo antes do processamento. |
| Por que importa | Suaviza picos; evita perdas em caso de queda. |
| Hookdeck | A Hookdeck absorve rajadas e suaviza a entrega para proteger os seus serviços. |
| Também chamado de | queue, staging area, cache, temporary storage, holding area, event buffer |
Termos relacionados: Queue · Burst control
Fan-in
| Propriedade | Descrição |
|---|---|
| Definição | Muitos provedores convergindo em um único ponto de entrada. |
| Por que importa | Centraliza autenticação e verificação e reduz a dispersão operacional. |
| Hookdeck | Receba de muitos provedores na Hookdeck; normalize e encaminhe internamente. |
| Também chamado de | aggregation, consolidation, many-to-one, collection point, convergence |
Termos relacionados: Ingestion · Routing
Ingestion
| Propriedade | Descrição |
|---|---|
| Definição | Recepção confiável de eventos de entrada (aceitar → buffer → persistir → despachar). |
| Por que importa | Absorve picos e desacopla provedores de consumidores. |
| Hookdeck | A Hookdeck é a sua entrada: recebe, verifica, faz buffer e então entrega. |
| Também chamado de | intake, intake pipeline, event ingestion, data ingestion, collection, event collection |
Termos relacionados: Buffer · Queue
Partition
| Propriedade | Descrição |
|---|---|
| Definição | Subconjunto ou faixa de um stream de eventos. |
| Por que importa | Escala o processamento preservando a ordem por chave. |
| Hookdeck | Roteie por chaves na Hookdeck para aproximar o comportamento de partições. |
| Também chamado de | shard, segment, slice, channel, lane, sub-stream |
Termos relacionados: Stream · Ordering
Queue
| Propriedade | Descrição |
|---|---|
| Definição | Estrutura FIFO para eventos que aguardam processamento. Cuidado para não confundir FIFO com ordering. |
| Por que importa | Controla concorrência e isolamento. |
| Hookdeck | As entregas ficam em fila na Hookdeck; controle a concorrência em direção à sua aplicação. |
| Também chamado de | message queue, event queue, task queue, work queue, processing queue |
Termos relacionados: Retry · DLQ
Stream
| Propriedade | Descrição |
|---|---|
| Definição | Log ordenado e particionado de eventos. |
| Por que importa | Suporta ingestão de alto throughput com ordenação por partição. |
| Hookdeck | Encaminhe da Hookdeck para o seu processador de streams, se necessário. |
| Também chamado de | log, topic, event stream, message stream, data stream, event log, commit log |
Termos relacionados: Partition · Routing
Roteamento e transformação
Decidir para onde cada evento vai e como o seu payload é moldado para que os consumidores possam agir. Isso importa porque reduz ruído e acoplamento, viabiliza múltiplos consumidores e mantém os dados utilizáveis entre serviços.
Enrichment
| Propriedade | Descrição |
|---|---|
| Definição | Adicionar dados vindos de outros sistemas. |
| Por que importa | Fornece contexto para decisões downstream mais inteligentes. |
| Hookdeck | Faça o enrichment nos serviços downstream; a Hookdeck foca em transporte e controle. |
| Também chamado de | hydration, augmentation, enhancement, data enrichment, context addition |
Termos relacionados: Transformation · Routing
Fan-out
| Propriedade | Descrição |
|---|---|
| Definição | Enviar um evento para muitos endpoints. |
| Por que importa | Permite que vários times e sistemas reajam ao mesmo evento. |
| Hookdeck | Faça fan-out da Hookdeck para faturamento, analytics, CRM etc. |
| Também chamado de | broadcast, multicast, one-to-many, distribution, replication, scatter |
Termos relacionados: Forwarding · Routing
Filtering
| Propriedade | Descrição |
|---|---|
| Definição | Incluir ou excluir eventos por meio de predicados. |
| Por que importa | Reduz ruído e custo downstream. |
| Hookdeck | Filtre na Hookdeck para que a sua aplicação veja apenas os eventos relevantes. Saiba mais |
| Também chamado de | rules, selectors, event filtering, event selection, subscription filtering, event discrimination, topic filtering, event criteria |
Termos relacionados: Routing · Transformation
Routing
| Propriedade | Descrição |
|---|---|
| Definição | Enviar eventos a destinos com base em regras (headers, tipo, campos do body). |
| Por que importa | Garante que os serviços certos recebam os eventos relevantes. |
| Hookdeck | Roteie por regras de header ou body na Hookdeck; direcione para os serviços certos. |
| Também chamado de | dispatch, fan-out, event routing, message routing, distribution, directing |
Termos relacionados: Filtering · Forwarding
Transformation
| Propriedade | Descrição |
|---|---|
| Definição | Mudar o formato do payload. |
| Por que importa | Normaliza entradas entre provedores e versões. |
| Hookdeck | Depois de consumir um webhook, modifique o payload usando Javascript antes da entrega. Saiba mais |
| Também chamado de | mapping, adapters, translation, conversion, reshaping, reformatting, normalization |
Termos relacionados: Enrichment · Schema drift
Semântica de entrega
O contrato de entrega: o que "entregue" significa e quais garantias existem (acknowledgement, ordenação, idempotência). Isso importa porque define expectativas corretas, orienta o design dos handlers e informa o comportamento de retry e reenvio.
Acknowledgement
| Propriedade | Descrição |
|---|---|
| Definição | Confirmação de recebimento pelo endpoint (por exemplo, 200/204). |
| Por que importa | Acks rápidos evitam retries e timeouts do provedor. |
| Hookdeck | A Hookdeck responde rapidamente aos provedores e depois entrega à sua aplicação de forma assíncrona. |
| Também chamado de | ack, 2xx response, receipt confirmation, delivery confirmation, success response, webhook acknowledgment, reception confirmation, ACK |
Termos relacionados: Delivery · Timeout
At-least-once
| Propriedade | Descrição |
|---|---|
| Definição | As entregas podem ser duplicadas, mas não perdidas. |
| Por que importa | É o padrão da maioria dos provedores; exige consumidores idempotentes. |
| Hookdeck | Adota at-least-once; combine com idempotência e deduplicação. |
| Também chamado de | guaranteed delivery, reliable delivery |
Termos relacionados: Idempotency · Retry
At-most-once
| Propriedade | Descrição |
|---|---|
| Definição | Sem duplicatas, mas com possibilidade de perda. |
| Por que importa | Não é ideal para cargas críticas. |
| Hookdeck | Prefira at-least-once + idempotência. |
| Também chamado de | best-effort delivery, fire-and-forget |
Termos relacionados: Delivery
Deduplication
| Propriedade | Descrição |
|---|---|
| Definição | Detectar e descartar duplicatas. |
| Por que importa | Evita cobranças em dobro, envios duplicados e distorção de dados. |
| Hookdeck | Combine os IDs do provedor com os IDs de entrega da Hookdeck para descartar duplicatas. |
| Também chamado de | de-dupe, duplicate detection, duplicate removal, duplicate filtering |
Termos relacionados: Idempotency · Replay
Delivery
| Propriedade | Descrição |
|---|---|
| Definição | Ato de enviar um evento a um endpoint; sucesso = HTTP 2xx. |
| Por que importa | Determina a política de retry/backoff e os alertas. |
| Hookdeck | A Hookdeck gerencia a entrega com retries, backoff e observabilidade. |
| Também chamado de | dispatch, push, transmission, send, event delivery, webhook delivery, notification delivery, message delivery |
Termos relacionados: Retry · Timeout · Latency
Exactly-once
| Propriedade | Descrição |
|---|---|
| Definição | Sem perda, sem duplicatas e em ordem. |
| Por que importa | Difícil de garantir sobre HTTP; emule no consumidor. |
| Hookdeck | Alcance isso com idempotência + deduplicação, não com promessas de transporte. |
| Também chamado de | guaranteed unique delivery, perfect delivery |
Termos relacionados: Idempotency · Deduplication
Idempotency
| Propriedade | Descrição |
|---|---|
| Definição | É seguro processar o mesmo evento mais de uma vez. |
| Por que importa | Permite retries e replays seguros, sem efeitos duplicados. |
| Hookdeck | A Hookdeck expõe IDs estáveis para que a sua aplicação registre e ignore duplicatas. |
| Também chamado de | deduplicated processing, idempotent processing, duplicate safety, re-delivery safety, multiple delivery handling, replay safety |
Termos relacionados: Retry · Replay · Correlation ID
Ordering
| Propriedade | Descrição |
|---|---|
| Definição | Garantias de sequência entre entregas. |
| Por que importa | Alguns fluxos precisam de ordem por chave; a maioria dos webhooks não garante isso. |
| Hookdeck | Não presuma ordem; projete consumidores para eventos fora de ordem. |
| Também chamado de | in-order delivery, sequential delivery, event ordering, message ordering, FIFO guarantee |
Termos relacionados: Partition · Idempotency
Confiabilidade e recuperação
Controles e padrões que mantêm as entregas funcionando sob falha (retry, backoff, timeouts, DLQ, replay, limites de taxa e de rajada, circuit breakers). Isso importa porque eles evitam perdas, protegem dependências e permitem uma recuperação segura e direcionada.
Backoff
| Propriedade | Descrição |
|---|---|
| Definição | Atraso crescente entre retries. |
| Por que importa | Evita thundering herds e contenção. |
| Hookdeck | A Hookdeck escalona os retries com backoff e jitter. |
| Também chamado de | exponential backoff, progressive delay, incremental retry, graduated retry, expanding intervals, geometric backoff, progressive backoff |
Termos relacionados: Retry · Rate limiting
Burst control
| Propriedade | Descrição |
|---|---|
| Definição | Suavizar picos curtos, transformando-os em um fluxo estável. |
| Por que importa | Evita sobrecarga e mantém a latência previsível. |
| Hookdeck | A Hookdeck suaviza picos com buffering e concorrência controlada. |
| Também chamado de | smoothing, traffic shaping, load leveling, spike dampening |
Termos relacionados: Rate limiting · Buffer
Circuit breaker
| Propriedade | Descrição |
|---|---|
| Definição | Parar temporariamente as chamadas a um endpoint que está falhando. |
| Por que importa | Evita falhas em cascata e protege os sistemas upstream. |
| Hookdeck | Pause ou desative o forwarding quando um endpoint degradar. Saiba mais |
| Também chamado de | failure protection, automatic cutoff, endpoint protection, overload protection, failure circuit |
Termos relacionados: Retry · Timeout
Dead Letter Queue (DLQ)
| Propriedade | Descrição |
|---|---|
| Definição | Guarda os eventos que falharam em definitivo. |
| Por que importa | Interrompe retries infinitos; permite revisão manual segura. |
| Hookdeck | A Hookdeck isola as entregas com falha permanente para revisão e replay. |
| Também chamado de | poison queue, failed message queue, error queue, undeliverable queue, failed webhook storage, retry exhaustion queue |
Termos relacionados: Retry · Replay
Rate limiting
| Propriedade | Descrição |
|---|---|
| Definição | Limitar as requisições aceitas por unidade de tempo. |
| Por que importa | Protege endpoints frágeis ou caros. |
| Hookdeck | Faça o throttling na Hookdeck para blindar os serviços downstream. Saiba mais |
| Também chamado de | throttling, request throttling, API throttling, rate control, request limiting |
Termos relacionados: Burst control · Backoff
Replay
| Propriedade | Descrição |
|---|---|
| Definição | Reenviar um evento histórico a um endpoint. |
| Por que importa | Corrige bugs e permite recuperação sem pedir reenvio ao provedor. |
| Hookdeck | Faça replay de eventos individuais ou de intervalos a partir da Hookdeck. |
| Também chamado de | re-drive, reprocess, re-run, event replay, message replay, historical replay |
Termos relacionados: Idempotency · DLQ
Retry
| Propriedade | Descrição |
|---|---|
| Definição | Novas tentativas de entrega após uma falha. |
| Por que importa | Evita perdas causadas por erros transitórios. |
| Hookdeck | Configure os retries da Hookdeck para que falhas transitórias não descartem eventos. Saiba mais |
| Também chamado de | redelivery, retry attempt, retry logic, retry mechanism, resend, re-attempt, failure recovery |
Termos relacionados: Backoff · DLQ
Timeout
| Propriedade | Descrição |
|---|---|
| Definição | Tempo máximo de espera pela resposta do endpoint. |
| Por que importa | Equilibra os SLAs do provedor com o tempo de processamento. |
| Hookdeck | A Hookdeck responde rápido aos provedores e segue com a entrega à sua aplicação. Saiba mais |
| Também chamado de | request timeout, connection timeout, response timeout, delivery timeout, time limit, maximum wait time, deadline |
Termos relacionados: Delivery · Latency
Segurança e governança de dados
Identidade, segurança de transporte, controle de acesso e tratamento/retenção de dados em webhooks. Isso importa porque preserva integridade e confidencialidade, limita o raio de impacto e atende a requisitos de conformidade.
Encryption at rest
| Propriedade | Descrição |
|---|---|
| Definição | Dados armazenados criptografados em disco. |
| Por que importa | Conformidade e redução de risco. |
| Hookdeck | Os dados são criptografados com AES-256. Retenha só o necessário; aplique as políticas de dados em repouso da sua organização. |
| Também chamado de | data-at-rest encryption, storage encryption, disk encryption |
Termos relacionados: PII masking · Retention window
Encryption in transit
| Propriedade | Descrição |
|---|---|
| Definição | TLS em todos os saltos de rede. |
| Por que importa | Impede interceptação e adulteração. |
| Hookdeck | Os dados são criptografados com TLS 1.2 ou superior. Termine o HTTPS na Hookdeck e encaminhe sobre TLS. |
| Também chamado de | HTTPS, transport encryption, wire encryption, data-in-transit encryption |
Termos relacionados: mTLS
IP allowlist
| Propriedade | Descrição |
|---|---|
| Definição | Aceitar apenas requisições de IPs de origem confiáveis. |
| Por que importa | Endurece a entrada; reduz a superfície de ataque. |
| Hookdeck | Coloque os IPs de saída da Hookdeck na allowlist da sua rede; bloqueie todo o resto. |
| Também chamado de | whitelist, allowlist, IP filtering, source IP restriction, network filtering, IP authorization, access control list (ACL) |
Termos relacionados: mTLS · Signature (HMAC)
mTLS
| Propriedade | Descrição |
|---|---|
| Definição | TLS mútuo entre emissor e receptor usando certificados de cliente. |
| Por que importa | Identidade mais forte do que segredos compartilhados. |
| Hookdeck | Mantenha a Hookdeck na borda; use mTLS nos saltos internos onde a política exigir. |
| Também chamado de | client cert auth, two-way SSL, bidirectional TLS, two-way TLS, certificate-based authentication |
Termos relacionados: Encryption in transit · Signature (HMAC)
OAuth (Webhook auth)
| Propriedade | Descrição |
|---|---|
| Definição | Autenticação baseada em token para receber ou encaminhar requisições. |
| Por que importa | Padroniza o acesso; menos comum em webhooks de entrada. |
| Hookdeck | A Hookdeck encaminha headers bearer se a sua aplicação os espera. Saiba mais |
| Também chamado de | bearer tokens, token authentication, API tokens, access tokens |
Termos relacionados: Signature (HMAC)
PII masking
| Propriedade | Descrição |
|---|---|
| Definição | Ocultar dados sensíveis em repouso e nos logs. |
| Por que importa | Conformidade e menor privilégio. |
| Hookdeck | Mantenha a retenção baixa; mascare ou evite armazenar PII nos logs downstream. |
| Também chamado de | redaction, data masking, data obfuscation, anonymization, sensitive data removal |
Termos relacionados: Encryption at rest · Retention window
Retention window
| Propriedade | Descrição |
|---|---|
| Definição | Por quanto tempo eventos e logs são mantidos. |
| Por que importa | Impacta privacidade, custo e conformidade. |
| Hookdeck | Defina uma retenção intencional; guarde apenas o necessário para replay e conformidade. |
| Também chamado de | TTL, retention period, data retention, storage duration, keep-alive period |
Termos relacionados: Replay · PII masking
Secret rotation
| Propriedade | Descrição |
|---|---|
| Definição | Trocar regularmente as chaves de assinatura e verificação. |
| Por que importa | Limita o raio de impacto de segredos vazados ou antigos. |
| Hookdeck | Rotacione os segredos dos provedores na Hookdeck; mantenha as chaves sobrepostas durante a transição. |
| Também chamado de | key rotation, key refresh, secret refresh, key management |
Termos relacionados: Signature (HMAC)
Signature (HMAC)
| Propriedade | Descrição |
|---|---|
| Definição | Prova criptográfica de que o evento veio do provedor (verificar o header de assinatura com um segredo compartilhado). |
| Por que importa | Impede falsificação; só eventos confiáveis chegam aos seus sistemas. |
| Hookdeck | Verifique as assinaturas dos provedores na Hookdeck; encaminhe apenas se as checagens passarem. Saiba mais |
| Também chamado de | signing secret, hash signature, message authentication code, security signature, verification signature, authentication hash, request signature, payload signature |
Saiba mais: Guia completo de segurança de webhooks · Como implementar verificação de assinatura SHA256 em webhooks
Termos relacionados: IP allowlist · mTLS
Desempenho e SLAs
As métricas e metas para o comportamento do sistema (códigos HTTP, latência, throughput, SLOs/SLAs). Isso importa porque elas orientam o planejamento de capacidade, os alertas e o ajuste de desempenho, para que a experiência atenda aos compromissos assumidos.
HTTP 2xx/4xx/5xx
| Propriedade | Descrição |
|---|---|
| Definição | Sucesso (2xx), erro do cliente (4xx), erro do servidor (5xx). |
| Por que importa | 4xx normalmente interrompem os retries; 5xx e timeouts disparam retries. |
| Hookdeck | Configure a política de retry e os alertas por rota. |
| Também chamado de | response codes, status responses, HTTP responses, result codes, return codes |
Termos relacionados: Retry · Timeout
Latency
| Propriedade | Descrição |
|---|---|
| Definição | Tempo entre o envio e o acknowledgement. |
| Por que importa | Impacta a experiência do usuário e os SLAs. |
| Hookdeck | A latência voltada ao provedor é minimizada; a latência de entrega interna é observável. |
| Também chamado de | response time, delivery latency, processing time, round-trip time |
Termos relacionados: Timeout · Throughput
SLA / SLO
| Propriedade | Descrição |
|---|---|
| Definição | Compromissos e objetivos de disponibilidade e latência. |
| Por que importa | Orienta os orçamentos de confiabilidade e os alertas. |
| Hookdeck | Meça nas rotas da Hookdeck e nos endpoints downstream. |
| Também chamado de | Service Level Agreement, Service Level Objective, uptime guarantee, performance targets |
Termos relacionados: Latency · Retry
Throughput
| Propriedade | Descrição |
|---|---|
| Definição | Eventos processados por unidade de tempo. |
| Por que importa | Planejamento de capacidade e controle de custos. |
| Hookdeck | O throughput do projeto define um teto de entrega por destino. Cada destino entrega, no máximo, o menor valor entre a sua taxa máxima de entrega e o throughput do projeto. |
| Também chamado de | TPS, RPS, events per second, messages per second, processing rate, event rate |
Termos relacionados: Rate limiting · Burst control
Observabilidade e ambientes
Enxergar o que está acontecendo e testar mudanças com segurança por meio de rastreamento/visibilidade e de sandbox, staging, blue-green e mocks. Isso importa porque acelera a depuração, torna regressões evidentes e reduz o risco ao entregar mudanças.
Blue/Green
| Propriedade | Descrição |
|---|---|
| Definição | Dois ambientes de produção para trocas sem downtime. |
| Por que importa | Reduz o risco em deploys e migrações. |
| Hookdeck | Pause uma rota e depois alterne o roteamento da Hookdeck entre blue e green durante os deploys. |
| Também chamado de | blue-green deployment, zero-downtime deployment, rolling deployment |
Termos relacionados: Staging · Routing
Correlation ID
| Propriedade | Descrição |
|---|---|
| Definição | ID usado para rastrear um único evento de ponta a ponta. |
| Por que importa | Conecta os logs entre saltos para facilitar a depuração. |
| Hookdeck | Logs completos e rastreabilidade dentro da Hookdeck. Saiba mais |
| Também chamado de | trace ID, request ID, message ID, event ID, webhook ID, transaction ID, unique identifier |
Termos relacionados: Visibility layer · Idempotency
Mock server
| Propriedade | Descrição |
|---|---|
| Definição | Simula o provedor para testar consumidores. |
| Por que importa | Permite testes determinísticos sem dependências externas. |
| Hookdeck | Use fixtures e mocks do provedor; encaminhe pela Hookdeck para testes de ponta a ponta. |
| Também chamado de | stub, test server, simulator, fake server, test double |
Termos relacionados: Sandbox
Sandbox
| Propriedade | Descrição |
|---|---|
| Definição | Ambiente seguro para testar webhooks. |
| Por que importa | Evita que dados de teste poluam a produção. |
| Hookdeck | Aponte o modo de teste do provedor para um projeto ou rotas de sandbox na Hookdeck; isole da produção. |
| Também chamado de | test mode, test environment, dev environment, staging sandbox |
Termos relacionados: Tunnel · Staging
Schema drift
| Propriedade | Descrição |
|---|---|
| Definição | O formato do payload muda ao longo do tempo. |
| Por que importa | Quebra consumidores silenciosamente; precisa ser detectado cedo. |
| Hookdeck | Use os logs da Hookdeck para identificar mudanças de payload; alerte pela sua stack de observabilidade. |
| Também chamado de | contract drift, schema evolution, payload drift, format drift, API versioning issues |
Termos relacionados: Transformation · Filtering
Staging
| Propriedade | Descrição |
|---|---|
| Definição | Ambiente de pré-produção que espelha a produção. |
| Por que importa | Valida correções antes do tráfego real. |
| Hookdeck | Use um projeto ou rotas separadas na Hookdeck para cada ambiente. |
| Também chamado de | pre-prod, UAT, pre-production, test environment |
Termos relacionados: Blue/Green · Sandbox
Visibility layer
| Propriedade | Descrição |
|---|---|
| Definição | Lugar central para observar e rastrear webhooks. |
| Por que importa | Acelera a depuração e a resposta a incidentes. |
| Hookdeck | A Hookdeck centraliza logs, busca e alertas para cada webhook. |
| Também chamado de | observability gateway, monitoring layer, telemetry layer, insights platform |
Termos relacionados: Webhook proxy · Correlation ID
Infraestrutura de webhooks, gerenciada para você
A Hookdeck cuida da ingestão, entrega, observabilidade e recuperação de erros — para que você não precise.