canonical: https://jentic.com/apis/hookdeck.com/hookdeck

# Hookdeck Admin REST API

Jentic publishes the only available OpenAPI specification for Hookdeck Admin REST API, keeping it validated and agent-ready. The Hookdeck Admin REST API manages every primitive in a Hookdeck event gateway: sources, destinations, connections, transformations, issue triggers, bookmarks, requests, events, attempts, and bulk retry operations. It supports filtering and replaying webhook traffic, building custom alerting on delivery issues, and inspecting every attempt against a destination. Useful for SRE teams running webhook-heavy systems and AI agents that diagnose delivery failures.

## For AI agents

Inspect, replay, and configure webhook delivery on Hookdeck - sources, destinations, events, attempts, and bulk retries.

## Scope

Does not handle outbound webhook delivery to your customers, payment processing, or message queue management - use for managing inbound webhook gateway operations only.

## Capabilities

- Configure sources and destinations to route inbound webhooks through Hookdeck
- Inspect individual events and their delivery attempts to diagnose failures
- Trigger bulk retries of failed events across a connection or filter window
- Create issue triggers to alert on delivery failures, transformation errors, or backpressure
- Apply transformations to mutate webhook payloads before they reach a destination
- Bookmark interesting events for replay during local development or incident review
- Pull delivery metrics for dashboards and on-call reporting

## Use cases

### Webhook Failure Triage Agent

Run an SRE agent that watches Hookdeck for failed webhook deliveries, groups them by destination, and decides whether to retry, escalate, or open a ticket. The agent calls GET /events with a filter on status=failed, inspects attempts via GET `/attempts/{id}`, and triggers bulk retries when a transient outage clears. Cuts mean time to recovery on webhook outages.

Example prompt: List failed events for connection_id=conn_123 in the last hour, then call POST on the bulk retry events resource to replay them.

### Webhook Onboarding Automation

Automate onboarding of new webhook sources for partner integrations. The agent calls POST /sources to register a new ingest URL, POST /destinations to point at the customer's endpoint, and ties them together with a connection. Replaces manual dashboard clicking when adding a new partner integration.

Example prompt: Create source 'partner-acme', destination pointing at https://acme.example.com/hooks, and a connection joining them.

### On-Call Alerting From Issue Triggers

Wire Hookdeck issue triggers into an on-call rotation. The agent creates issue triggers via POST /issue-triggers for delivery failures or transformation errors, with a payload that posts to PagerDuty or Slack. Engineers stop missing webhook outages buried in dashboards.

Example prompt: Create an issue trigger that fires when a destination has more than 10 failed attempts in 5 minutes and POST it via /issue-triggers.

### Replay Production Webhooks Locally

Bookmark interesting production events in Hookdeck and replay them against a local environment via the trigger endpoint. The agent calls POST `/bookmarks/{id}/trigger` to fire the bookmarked event on demand. Speeds up debugging webhook-driven flows without waiting for the next live event.

Example prompt: List bookmarks tagged 'failed-checkout', then trigger bookmark id bk_456 against the local development destination.

### AI Webhook Operations Agent via Jentic

Expose Hookdeck's 116 endpoints to an AI ops agent through Jentic. The agent finds the right operation via intent search ('retry failed events for stripe connection'), Jentic loads the schema, and the agent executes with bearer auth handled in your Jentic One instance.

Example prompt: Search Jentic for 'bulk retry failed events', load the schema, and execute against connection_id=conn_prod for the last 30 minutes.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/events` | List events with filtering by status and connection |
| GET | `/attempts` | List delivery attempts across events |
| POST | `/sources` | Create a new inbound source |
| POST | `/destinations` | Create a new outbound destination |
| POST | `/issue-triggers` | Create an alerting issue trigger |
| POST | `/bookmarks/{id}/trigger` | Replay a bookmarked event |
| GET | `/connections` | List source-to-destination connections |

## Key resources

- **Sources** — Inbound endpoints that receive webhooks from upstream systems.
- **Destinations** — Outbound endpoints where Hookdeck delivers processed events.
- **Connections** — Glue between a source and destination, with filtering and routing rules.
- **Events** — Individual webhook events flowing through the gateway, with delivery state.
- **Attempts** — Per-attempt records for each event delivery, including status and response.
- **Bulk retries** — Operations to retry many events at once across a filter or connection.
- **Issue Triggers** — Rules that raise alerts on delivery, transformation, or backpressure issues.
- **Transformations** — JavaScript transforms that mutate event payloads before delivery.
- **Bookmarks** — Saved events used to replay traffic on demand for development or incident review.

## Why Jentic

- **Setup:** Wiring Hookdeck by hand means setting up its bearer or basic auth, tracking the dated api.hookdeck.com/2025-07-01 host across more than a hundred endpoints, and handling errors yourself. Through Jentic you install once, import the Hookdeck Admin REST API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** With over a hundred gateway operations, scope your agent to the ones it needs, such as listing events or retrying attempts. You choose which calls are in the allowed set, so operations like deleting sources or destinations are excluded unless you add them.
- **Credential handling:** Your Hookdeck bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'retry failed events' or 'create a webhook source', and Jentic returns the matching Hookdeck operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Svix API** — Webhook-as-a-service platform focused on outbound delivery for SaaS providers.
- **ngrok API** — Tunnels local services to the public internet for webhook development.
- **Pipedream API** — Workflow runtime that consumes webhooks and orchestrates multi-step automations.

## FAQ

### Why is there no official OpenAPI spec for Hookdeck Admin REST API?

Hookdeck does not publish a maintained public OpenAPI specification for the admin REST API. Jentic generates and maintains this spec so that AI agents and developers can call Hookdeck Admin REST API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Hookdeck Admin REST API use?

The API supports bearer token auth (preferred) and HTTP basic. Generate an API key in the Hookdeck dashboard and pass it as Authorization: Bearer <key>. Jentic stores the key in your Jentic One instance so agents never see the raw token.

### Can I bulk retry failed webhooks with the Hookdeck Admin REST API?

Yes. The Bulk retry events resource accepts a filter (connection_id, time window, status) and replays every matching event. Bulk retry requests works the same way for inbound requests. Useful when an upstream destination recovers from an outage.

### What are the rate limits for the Hookdeck Admin REST API?

Hookdeck applies workspace-level rate limits that scale with plan tier. Honor 429 responses and use the bulk retry resources rather than looping single retries - bulk operations count as one request even when they cover thousands of events.

### How do I create an issue trigger with the Hookdeck Admin REST API through Jentic?

Run pip install jentic, search for 'create Hookdeck issue trigger', load the POST /issue-triggers schema, and execute with the trigger config (event type, channel, threshold). Jentic injects the bearer key for you.

### Can I replay a single event with the Hookdeck Admin REST API?

Yes. Bookmark the event via POST /bookmarks, then trigger the replay with POST `/bookmarks/{id}/trigger.` This sends the bookmarked payload through the configured connection again - handy for debugging without waiting for a live event.

### Can I limit what my agent is allowed to do with the Hookdeck Admin REST API?

Yes. Because Jentic One is self-hosted, you decide which of Hookdeck's hundred-plus gateway operations your agent may call, so you can allow read-and-recover work like listing events, inspecting attempts, and triggering bulk retries while leaving everything else out. Destructive operations such as deleting sources or destinations stay outside the allowed set unless you add them yourself. Your rules run in your own instance, and the bearer or basic credential is injected at execution time rather than exposed to the agent.
