Catalisa.Building Blocks

API do Webhooks Engine

18 endpoints em 6 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

19 endpoints

Subscriptions

/webhooks-engine/api/v1/subscriptions8
  • POST/webhooks-engine/api/v1/subscriptionsCria subscription e gera o primeiro par de chavesWEBHOOKS_SUBSCRIPTIONS_CREATE
  • GET/webhooks-engine/api/v1/subscriptionsLista, paginado, filtros filter[status] e filter[subaccountId]WEBHOOKS_SUBSCRIPTIONS_READ
  • GET/webhooks-engine/api/v1/subscriptions/:idBusca por UUIDWEBHOOKS_SUBSCRIPTIONS_READ
  • PATCH/webhooks-engine/api/v1/subscriptions/:idAtualiza URL, filtros, timeout, retentativa, headersWEBHOOKS_SUBSCRIPTIONS_UPDATE
  • DELETE/webhooks-engine/api/v1/subscriptions/:idExclusão lógica. Responde 204WEBHOOKS_SUBSCRIPTIONS_DELETE
  • POST/webhooks-engine/api/v1/subscriptions/:id/pauseACTIVE → PAUSED. Para de receber eventos novosWEBHOOKS_SUBSCRIPTIONS_UPDATE
  • POST/webhooks-engine/api/v1/subscriptions/:id/resumePAUSED → ACTIVEWEBHOOKS_SUBSCRIPTIONS_UPDATE
  • POST/webhooks-engine/api/v1/subscriptions/:id/testEnvia um webhook.test assinado, síncrono. **Não** grava log de entregaWEBHOOKS_SUBSCRIPTIONS_READ

Chaves de assinatura

/webhooks-engine/api/v1/subscriptions4
  • GET/webhooks-engine/api/v1/subscriptions/:subscriptionId/keysLista chaves ACTIVE e ROTATING com as públicas em PEMWEBHOOKS_KEYS_READ
  • GET/webhooks-engine/api/v1/subscriptions/:subscriptionId/keys/:keyIdBusca uma chave pelo keyId (whk_...)WEBHOOKS_KEYS_READ
  • POST/webhooks-engine/api/v1/subscriptions/:subscriptionId/keys/rotateCria chave nova; antiga vira ROTATING. Responde 201WEBHOOKS_KEYS_ROTATE
  • DELETE/webhooks-engine/api/v1/subscriptions/:subscriptionId/keys/:keyIdRevoga imediatamente. Responde 200 com a chave revogadaWEBHOOKS_KEYS_REVOKE

Chaves públicas do escopo

/webhooks-engine/api/v1/public-keys1
  • GET/webhooks-engine/api/v1/public-keysChaves ACTIVE e ROTATING de todos os endpoints do escopo (a subconta vê só as dela), com keyId, subscriptionId e a pública em PEMWEBHOOKS_KEYS_READ

Logs de entrega

/webhooks-engine/api/v1/delivery-logs3
  • GET/webhooks-engine/api/v1/delivery-logsLista, paginado, com filtrosWEBHOOKS_DELIVERIES_READ
  • GET/webhooks-engine/api/v1/delivery-logs/:idBusca um log, com payload e respostaWEBHOOKS_DELIVERIES_READ
  • POST/webhooks-engine/api/v1/delivery-logs/:id/retryReenvia. Só aceita FAILED ou RETRYINGWEBHOOKS_DELIVERIES_RETRY

Configuração da organização

/webhooks-engine/api/v1/config2
  • GET/webhooks-engine/api/v1/configLê a configuração; cria com os padrões se não existirWEBHOOKS_CONFIG_MANAGE
  • PATCH/webhooks-engine/api/v1/configAltera retentionDays (1–365) e maxSubscriptions (1–1000)WEBHOOKS_CONFIG_MANAGE

Saúde

/webhooks-engine/health1
  • GET/webhooks-engine/healthSonda de vida. Não exige token.