Hookbase
Docs
GuideAPI ReferenceIntegrationsUse CasesCLIMCP
Getting StartedSDK ReferencePortal ComponentsAPI Reference
Get Started

API Reference

OverviewAPI ExplorerAuthenticationAPI Keys

Core Endpoints

SourcesDestinationsRoutesEventsDeliveriesDelivery ClustersTransformsFiltersSchemasWebhook IngestAnalytics

Development Tools

TunnelsCron JobsCron GroupsScheduled Sends

Administration

Custom DomainsAudit LogsNotification ChannelsAlert RulesRedaction PoliciesObservability Export
DocsReceiveAPIDelivery Clusters

Delivery Clusters API

Hookbase groups failed deliveries that share a failure fingerprint (same route, destination, response status, and error signature) into clusters, so you can triage a recurring failure once instead of delivery-by-delivery.

Endpoints

MethodPathDescription
GET/api/delivery-clustersList recent failure clusters
GET/api/delivery-clusters/{fingerprint}/eventsList the events in a cluster
POST/api/delivery-clusters/{fingerprint}/replay-allReplay every delivery in a cluster

Cluster Object

{
  "fingerprint": "a1b2c3d4",
  "count": 128,
  "affectedEventCount": 128,
  "firstSeen": "2024-01-15T08:00:00Z",
  "lastSeen": "2024-01-15T10:30:00Z",
  "routeId": "rte_main456",
  "routeName": "GitHub to Production",
  "destinationId": "dst_api123",
  "destinationName": "Production API",
  "responseStatus": 500,
  "errorMessageExcerpt": "Internal Server Error",
  "rcaCategory": "destination_5xx",
  "sampleDeliveryId": "dlv_abc123",
  "sampleEventId": "evt_xyz789"
}

List Clusters

GET /api/delivery-clusters

Query Parameters

ParameterTypeDescription
sinceHoursnumberLook-back window in hours (default: 24, max: 720)
limitnumberMax clusters to return (default: 50, max: 200)

Example

curl "https://api.hookbase.app/api/delivery-clusters?sinceHours=24&limit=50" \
  -H "Authorization: Bearer whr_your_api_key"

Response

{
  "clusters": [
    {
      "fingerprint": "a1b2c3d4",
      "count": 128,
      "destinationName": "Production API",
      "responseStatus": 500,
      "errorMessageExcerpt": "Internal Server Error",
      "firstSeen": "2024-01-15T08:00:00Z",
      "lastSeen": "2024-01-15T10:30:00Z"
    }
  ],
  "since": "2024-01-14T10:30:00Z",
  "sinceHours": 24
}

List Cluster Events

Return the events whose deliveries belong to a cluster.

GET /api/delivery-clusters/{fingerprint}/events

Query Parameters

ParameterTypeDescription
limitnumberMax events to return (default: 500, max: 5000)

Replay a Cluster

Replay every failed delivery in a cluster in one call. Optionally override the destination, apply a one-off transform, or add headers.

POST /api/delivery-clusters/{fingerprint}/replay-all

Request Body (optional)

FieldTypeDescription
destinationOverridestringSend all replays to a different destination ID
transformOverrideobject{ code, type?, inputFormat?, outputFormat? } (code max 64KB)
headersOverrideobjectExtra request headers (max 50)
persistTransformbooleanSave transformOverride to the route (requires transformOverride)
limitnumberCap the number of deliveries replayed

Example

curl -X POST https://api.hookbase.app/api/delivery-clusters/a1b2c3d4/replay-all \
  -H "Authorization: Bearer whr_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "limit": 100 }'

Info

Clusters are a read/triage view over failed deliveries — see the Deliveries API to inspect or replay an individual delivery.

PreviousDeliveriesNextTransforms

On this page

EndpointsCluster ObjectList ClustersQuery ParametersExampleResponseList Cluster EventsQuery ParametersReplay a ClusterRequest Body (optional)Example