> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Hookdeck

The Hookdeck connector lets your AI agent act in each user's Hookdeck account. Each user connects their own Hookdeck access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** Bearer Token
**Categories:** Developer Tools, Monitoring
**Tools:** 60: 27 read, 26 write, 7 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=HOOKDECK)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Hookdeck connection

   In **AgentKit > Connections**, create a Hookdeck connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'hookdeck'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Hookdeck:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'hookdeck_attempts_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "hookdeck"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Hookdeck:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="hookdeck_attempts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Hookdeck credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'hookdeck_attempt_get',
  toolInput: {
    id: '<id>',
  },
  connector: 'hookdeck',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="hookdeck_attempt_get",
    tool_input={
        "id": "<id>",
    },
    connection_name="hookdeck",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `hookdeck_attempt_get`

Get Attempt · Read-only

Get one delivery attempt by ID. Returns the attempt with status, response status, response body, error code and duration. Use this to read what the destination answered.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Attempt ID. Example: atm_7YtqvL2c9NeF.

Example input: `{"id":"<id>"}`

### `hookdeck_attempts_list`

List Attempts · Read-only

List delivery attempts, usually for one event. Returns models with id, event_id, attempt_number, status, response_status, error_code and timing. Use this to see each try of an event. Use hookdeck_attempt_get for one attempt's response.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dir` (`string`, optional): Sort direction(s). One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `event_id` (`string`, optional): Event the attempt is associated with. Example: evt_3fWxkUC9jw0aRS.
- `id` (`string`, optional): ID of the attempt. Example: web_UfM8Bmr4zxlW.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key(s). One of: created_at. Example: created_at. One of: `created_at`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.

Example input: `{}`

### `hookdeck_bookmark_get`

Get Bookmark · Read-only

Get one bookmark by ID. Returns the bookmark with its label, connection and event data ID. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Bookmark ID. Example: bmk_2Xc8Lm4pQ9sT.

Example input: `{"id":"<id>"}`

### `hookdeck_bookmarks_list`

List Bookmarks · Read-only

List bookmarks (saved request payloads that can be replayed to a connection). Returns models with id, label, webhook_id and event_data_id. Use this to find a saved payload. Use hookdeck_bookmark_trigger to replay it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dir` (`string`, optional): Sort direction(s). One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `event_data_id` (`string`, optional): Filter by associated event data ID. Example: edt_0c7b5BkAn3kq.
- `id` (`string`, optional): Filter by bookmark IDs. Example: web_UfM8Bmr4zxlW.
- `label` (`string`, optional): Filter by label. Example: sk-test failed order webhook.
- `last_used_at_gte` (`string`, optional): Only include results whose last used at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `last_used_at_lte` (`string`, optional): Only include results whose last used at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `name` (`string`, optional): Filter by bookmark name. Example: sk-test-orders.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key(s). One of: created_at. Example: created_at. One of: `created_at`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `webhook_id` (`string`, optional): Filter by associated connection (webhook) ID. Example: web_UfM8Bmr4zxlW.

Example input: `{}`

### `hookdeck_connection_get`

Get Connection · Read-only

Get one connection by ID. Returns the connection with its source, destination, rules and paused/disabled timestamps. Use this when you know the ID. Use hookdeck_connections_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Connection ID. Example: web_UfM8Bmr4zxlW.

Example input: `{"id":"<id>"}`

### `hookdeck_connections_list`

List Connections · Read-only

List connections (a source wired to a destination, with rules) in the project, filtered by name, source, destination or disabled state. Returns models with id, name, full_name, source, destination, rules, paused_at and disabled_at, plus pagination cursors. Use this to browse connections. Use hookdeck_connection_get for one connection by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `destination_id` (`string`, optional): Filter by associated destination IDs. Example: des_8KgLp1vAEz7H.
- `dir` (`string`, optional): Sort direction(s). One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `disabled` (`boolean`, optional): Include disabled resources in the response. Example: true.
- `disabled_at_gte` (`string`, optional): Only include results whose disabled at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `disabled_at_lte` (`string`, optional): Only include results whose disabled at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `full_name` (`string`, optional): Fuzzy match the concatenated source and connection name. The source name and connection name must be separated by " -> ". Example: shopify > orders-api.
- `id` (`string`, optional): Filter by connection IDs. Example: web_UfM8Bmr4zxlW.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `name` (`string`, optional): Filter by connection name. Example: orders-api.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key(s). One of: full_name, created_at, updated_at. Example: created_at. One of: `full_name`, `created_at`, `updated_at`.
- `paused_at_gte` (`string`, optional): Only include results whose paused at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `paused_at_lte` (`string`, optional): Only include results whose paused at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `source_id` (`string`, optional): Filter by associated source IDs. Example: src_yt8RaJNLxNEP.

Example input: `{}`

### `hookdeck_destination_get`

Get Destination · Read-only

Get one destination by ID. Returns the destination with its type and config. Use this when you know the ID. Use hookdeck_destinations_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Destination ID. Example: des_8KgLp1vAEz7H.
- `include` (`string`, optional): include. One of: config.auth. Example: config.auth. One of: `config.auth`.

Example input: `{"id":"<id>"}`

### `hookdeck_destinations_list`

List Destinations · Read-only

List destinations (where Hookdeck delivers events) in the project, filtered by ID, name, type or disabled state. Returns models with id, name, type and config (URL, rate limit, auth), plus pagination cursors. Use this to browse destinations. Use hookdeck_destination_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dir` (`string`, optional): Sort direction. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `disabled` (`boolean`, optional): Include disabled resources in the response. Example: true.
- `disabled_at_gte` (`string`, optional): Only include results whose disabled at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `disabled_at_lte` (`string`, optional): Only include results whose disabled at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `id` (`string`, optional): Filter by destination IDs. Example: web_UfM8Bmr4zxlW.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `name` (`string`, optional): The destination name. Example: orders-api.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key. One of: name, created_at, updated_at. Example: name. One of: `name`, `created_at`, `updated_at`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `type` (`string`, optional): Filter by destination type. One of: HTTP, CLI, MOCK_API, SQS. Example: HTTP. One of: `HTTP`, `CLI`, `MOCK_API`, `SQS`.

Example input: `{}`

### `hookdeck_event_get`

Get Event · Read-only

Get one event by ID. Returns the event with status, attempts, response status, error code and the delivered request data. Use this to inspect a delivery. Use hookdeck_attempts_list for each try.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Event ID. Example: evt_3fWxkUC9jw0aRS.

Example input: `{"id":"<id>"}`

### `hookdeck_events_list`

List Events · Read-only

List events (one delivery of a request to a destination) filtered by status, connection, source, destination, response status, error code, dates or a text search on body, headers or path. Returns models with id, status, webhook_id, attempts, response_status, error_code and timestamps, plus pagination cursors. Use this to find failed or pending deliveries. Use hookdeck_event_get for one event, or hookdeck_requests_list for what was received.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `attempts` (`integer`, optional): Filter by number of attempts. Example: 3.
- `body` (`string`, optional): URL Encoded string of the JSON to match to the data body. Example: {"status":"paid"}
- `cli_id` (`string`, optional): Filter by CLI IDs. ?[any]=true operator for any CLI. Example: cl_5bFpQ3n8sKx2.
- `created_at_gte` (`string`, optional): Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `created_at_lte` (`string`, optional): Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `delivery_group` (`string`, optional): Filter by delivery group; null matches events without a delivery group. Example: orders.
- `destination_id` (`string`, optional): Filter by destination IDs. Example: des_8KgLp1vAEz7H.
- `dir` (`string`, optional): Sort direction. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `error_code` (`string`, optional): Filter by error code code. One of: BAD_RESPONSE, CANCELLED, TIMEOUT, NOT_FOUND, CANCELLED_PAST_RETENTION, CONNECTION_REFUSED, CONNECTION_RESET, CONNECTION_TIMEOUT, MISSING_URL, CLI, CLI_UNAVAILABLE, CLI_BINARY_UNSUPPORTED, SELF_SIGNED_CERT, ERR_TLS_CERT_ALTNAME_INVALID, ERR_SSL_WRONG_VERSION_NUMBER, NETWORK_ERROR, NETWORK_REQUEST_CANCELED, NETWORK_UNREACHABLE, TOO_MANY_REDIRECTS, INVALID_CHARACTER, INVALID_URL, SSL_ERROR_CA_UNKNOWN, DATA_ARCHIVED, SSL_CERT_EXPIRED, BULK_RETRY_CANCELLED, DNS_LOOKUP_FAILED, DNS_NO_RECORDS, HOST_UNREACHABLE, INTERNAL_ERROR, PROTOCOL_ERROR, PAYLOAD_MISSING, PAYLOAD_TOO_LARGE, UNABLE_TO_GET_ISSUER_CERT, SOCKET_CLOSED, SQS_BINARY_UNSUPPORTED, SQS_INVALID_MESSAGE_GROUP_ID, SQS_MESSAGE_TOO_LARGE, OAUTH2_HANDSHAKE_FAILED, DESTINATION_AUTH_FAILED, Z_DATA_ERROR, UNKNOWN. Example: TIMEOUT. One of: `BAD_RESPONSE`, `CANCELLED`, `TIMEOUT`, `NOT_FOUND`, `CANCELLED_PAST_RETENTION`, `CONNECTION_REFUSED`, `CONNECTION_RESET`, `CONNECTION_TIMEOUT`, `MISSING_URL`, `CLI`, `CLI_UNAVAILABLE`, `CLI_BINARY_UNSUPPORTED`, `SELF_SIGNED_CERT`, `ERR_TLS_CERT_ALTNAME_INVALID`, `ERR_SSL_WRONG_VERSION_NUMBER`, `NETWORK_ERROR`, `NETWORK_REQUEST_CANCELED`, `NETWORK_UNREACHABLE`, `TOO_MANY_REDIRECTS`, `INVALID_CHARACTER`, `INVALID_URL`, `SSL_ERROR_CA_UNKNOWN`, `DATA_ARCHIVED`, `SSL_CERT_EXPIRED`, `BULK_RETRY_CANCELLED`, `DNS_LOOKUP_FAILED`, `DNS_NO_RECORDS`, `HOST_UNREACHABLE`, `INTERNAL_ERROR`, `PROTOCOL_ERROR`, `PAYLOAD_MISSING`, `PAYLOAD_TOO_LARGE`, `UNABLE_TO_GET_ISSUER_CERT`, `SOCKET_CLOSED`, `SQS_BINARY_UNSUPPORTED`, `SQS_INVALID_MESSAGE_GROUP_ID`, `SQS_MESSAGE_TOO_LARGE`, `OAUTH2_HANDSHAKE_FAILED`, `DESTINATION_AUTH_FAILED`, `Z_DATA_ERROR`, `UNKNOWN`.
- `headers` (`string`, optional): URL Encoded string of the JSON to match to the data headers. Example: {"x-shopify-topic":"orders/create"}
- `id` (`string`, optional): Filter by event IDs. Example: web_UfM8Bmr4zxlW.
- `include` (`string`, optional): Set to data to include the data object on each event: the request as delivered to the destination (URL, method, path, query, headers and body). Text and JSON bodies are returned in full, so responses can be very large: up to limit events, each with a body up to your plan's maximum payload size. Binary bodies are null, except multipart bodies, which come back with their text fields and a placeholder for each file. Use GET /events/{id}/raw_body for the raw body. Use a small limit, or retrieve a single event with GET /events/{id}. One of: data. Example: data. One of: `data`.
- `last_attempt_at_gte` (`string`, optional): Only include results whose last attempt at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `last_attempt_at_lte` (`string`, optional): Only include results whose last attempt at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `next_attempt_at_gte` (`string`, optional): Only include results whose next attempt at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `next_attempt_at_lte` (`string`, optional): Only include results whose next attempt at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `order_by` (`string`, optional): Sort key. One of: created_at. Example: created_at. One of: `created_at`.
- `parsed_query` (`string`, optional): URL Encoded string of the JSON to match to the parsed query (JSON representation of the query). Example: {"page":"1"}
- `path` (`string`, optional): URL Encoded string of the value to match partially to the path. Example: /webhooks/orders.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `response_status` (`integer`, optional): Filter by HTTP response status code. Example: 500.
- `search_term` (`string`, optional): URL Encoded string of the value to match partially to the body, headers, parsed_query or path. Example: order_id.
- `source_id` (`string`, optional): Filter by source IDs. Example: src_yt8RaJNLxNEP.
- `status` (`string`, optional): Lifecyle status of the event. One of: SCHEDULED, QUEUED, HOLD, SUCCESSFUL, FAILED, CANCELLED. Example: FAILED. One of: `SCHEDULED`, `QUEUED`, `HOLD`, `SUCCESSFUL`, `FAILED`, `CANCELLED`.
- `successful_at_gte` (`string`, optional): Only include results whose successful at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `successful_at_lte` (`string`, optional): Only include results whose successful at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `webhook_id` (`string`, optional): Filter by connection (webhook) IDs. Example: web_UfM8Bmr4zxlW.

Example input: `{}`

### `hookdeck_issue_get`

Get Issue · Read-only

Get one issue by ID. Returns the issue with type, status, aggregation keys, reference and timestamps. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Issue ID. Example: iss_Qn4Lp8sT2w1x.

Example input: `{"id":"<id>"}`

### `hookdeck_issue_trigger_get`

Get Issue Trigger · Read-only

Get one issue trigger by ID. Returns the trigger with its type, configs and channels. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Issue trigger ID. Example: it_BXBPmXR5tE1V.

Example input: `{"id":"<id>"}`

### `hookdeck_issue_triggers_list`

List Issue Triggers · Read-only

List issue triggers (rules that open issues and notify email, Slack, Microsoft Teams or other channels). Returns models with id, name, type, configs, channels and disabled_at. Use this to review alerting. Use hookdeck_issue_trigger_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dir` (`string`, optional): Sort direction(s). One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `disabled_at_gte` (`string`, optional): Only include results whose disabled at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `disabled_at_lte` (`string`, optional): Only include results whose disabled at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `name` (`string`, optional): Filter by issue trigger name. Example: sk-test-delivery-alerts.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key(s). One of: created_at, type. Example: created_at. One of: `created_at`, `type`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `type` (`string`, optional): Issue type. Example: delivery.

Example input: `{}`

### `hookdeck_issues_count`

Count Issues · Read-only

Count issues matching the same filters as hookdeck_issues_list. Returns count. Use this for a number, e.g. open delivery issues. Use hookdeck_issues_list for the issues.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `aggregation_keys` (`object`, optional): Filter by aggregation keys. Example: {"webhook_id":["web_UfM8Bmr4zxlW"]}
- `created_at_gte` (`string`, optional): Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `created_at_lte` (`string`, optional): Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `dir` (`string`, optional): Sort direction(s). One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `dismissed_at_gte` (`string`, optional): Only include results whose dismissed at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `dismissed_at_lte` (`string`, optional): Only include results whose dismissed at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `first_seen_at_gte` (`string`, optional): Only include results whose first seen at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `first_seen_at_lte` (`string`, optional): Only include results whose first seen at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `id` (`string`, optional): Filter by Issue IDs. Example: iss_Qn4Lp8sT2w1x.
- `issue_trigger_id` (`string`, optional): Filter by Issue trigger IDs. Example: it_BXBPmXR5tE1V.
- `last_seen_at_gte` (`string`, optional): Only include results whose last seen at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `last_seen_at_lte` (`string`, optional): Only include results whose last seen at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `merged_with` (`string`, optional): Filter by Merged Issue IDs. Example: iss_Qn4Lp8sT2w1x.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key(s). One of: created_at, first_seen_at, last_seen_at, opened_at, status. Example: last_seen_at. One of: `created_at`, `first_seen_at`, `last_seen_at`, `opened_at`, `status`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `status` (`string`, optional): Filter by Issue statuses. One of: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED. Example: OPENED. One of: `OPENED`, `IGNORED`, `ACKNOWLEDGED`, `RESOLVED`.
- `type` (`string`, optional): Filter by Issue types. Example: delivery.

Example input: `{}`

### `hookdeck_issues_list`

List Issues · Read-only

List issues (grouped delivery, transformation, backpressure or request failures) filtered by type, status, trigger and dates. Returns models with id, type, status, aggregation_keys, first_seen_at and last_seen_at, plus pagination cursors. Use this to triage open problems. Use hookdeck_issues_count for a count only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `aggregation_keys` (`object`, optional): Filter by aggregation keys. Example: {"webhook_id":["web_UfM8Bmr4zxlW"]}
- `created_at_gte` (`string`, optional): Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `created_at_lte` (`string`, optional): Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `dir` (`string`, optional): Sort direction(s). One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `dismissed_at_gte` (`string`, optional): Only include results whose dismissed at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `dismissed_at_lte` (`string`, optional): Only include results whose dismissed at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `first_seen_at_gte` (`string`, optional): Only include results whose first seen at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `first_seen_at_lte` (`string`, optional): Only include results whose first seen at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `id` (`string`, optional): Filter by Issue IDs. Example: iss_Qn4Lp8sT2w1x.
- `issue_trigger_id` (`string`, optional): Filter by Issue trigger IDs. Example: it_BXBPmXR5tE1V.
- `last_seen_at_gte` (`string`, optional): Only include results whose last seen at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `last_seen_at_lte` (`string`, optional): Only include results whose last seen at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `merged_with` (`string`, optional): Filter by Merged Issue IDs. Example: iss_Qn4Lp8sT2w1x.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key(s). One of: created_at, first_seen_at, last_seen_at, opened_at, status. Example: last_seen_at. One of: `created_at`, `first_seen_at`, `last_seen_at`, `opened_at`, `status`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `status` (`string`, optional): Filter by Issue statuses. One of: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED. Example: OPENED. One of: `OPENED`, `IGNORED`, `ACKNOWLEDGED`, `RESOLVED`.
- `type` (`string`, optional): Filter by Issue types. Example: delivery.

Example input: `{}`

### `hookdeck_metrics_events_query`

Query Event Metrics · Read-only

Query event delivery metrics over a time range, bucketed by granularity and optionally grouped by connection, destination, status or error code. Returns one row per time bucket and dimension with the requested measures. Use this for delivery volume and failure rates. Use hookdeck_metrics_requests_query for inbound volume.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `date_range_end` (`string`, required): End of the time range, ISO 8601 date-time. Example: 2026-01-02T00:00:00Z.
- `date_range_start` (`string`, required): Start of the time range, ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `dimensions` (`array`, optional): Dimensions to group by. Example: ["webhook_id"]
- `filter_webhook_id` (`string`, optional): Only count data for this connection ID. Example: web_UfM8Bmr4zxlW.
- `granularity` (`string`, optional): Time bucket granularity. Format: <number><unit> where unit is s (seconds 1-60), m (minutes 1-60), h (hours 1-24), d (days 1-31), w (weeks 1-4), M (months 1-12). Examples: 1s, 5m, 1h, 1d. Example: 1h.
- `measures` (`array`, optional): Measures to return, e.g. count, successful_count, failed_count, error_rate, avg_attempts. Example: ["count"]

Example input: `{"date_range_end":"<date_range_end>","date_range_start":"<date_range_start>"}`

### `hookdeck_metrics_requests_query`

Query Request Metrics · Read-only

Query received-request metrics over a time range, bucketed by granularity and optionally grouped by source or rejection cause. Returns one row per time bucket and dimension with the requested measures. Use this for inbound volume and rejections. Use hookdeck_metrics_events_query for deliveries.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `date_range_end` (`string`, required): End of the time range, ISO 8601 date-time. Example: 2026-01-02T00:00:00Z.
- `date_range_start` (`string`, required): Start of the time range, ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `dimensions` (`array`, optional): Dimensions to group by. Example: ["source_id"]
- `filter_source_id` (`string`, optional): Only count data for this source ID. Example: src_yt8RaJNLxNEP.
- `granularity` (`string`, optional): Time bucket granularity. Format: <number><unit> where unit is s (seconds 1-60), m (minutes 1-60), h (hours 1-24), d (days 1-31), w (weeks 1-4), M (months 1-12). Examples: 1s, 5m, 1h, 1d. Example: 1h.
- `measures` (`array`, optional): Measures to return, e.g. count, accepted_count, rejected_count, discarded_count, avg_events_per_request. Example: ["count"]

Example input: `{"date_range_end":"<date_range_end>","date_range_start":"<date_range_start>"}`

### `hookdeck_request_events_list`

List Request Events · Read-only

List the events created from one request. Returns event models with status and destination, plus pagination cursors. Use this to trace a request to its deliveries.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Request ID. Example: req_ZcR8m2Qp1aLs.
- `attempts` (`integer`, optional): Filter by number of attempts. Example: 3.
- `body` (`string`, optional): URL Encoded string of the JSON to match to the data body. Example: {"status":"paid"}
- `cli_id` (`string`, optional): Filter by CLI IDs. ?[any]=true operator for any CLI. Example: cl_5bFpQ3n8sKx2.
- `created_at_gte` (`string`, optional): Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `created_at_lte` (`string`, optional): Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `delivery_group` (`string`, optional): Filter by delivery group; null matches events without a delivery group. Example: orders.
- `destination_id` (`string`, optional): Filter by destination IDs. Example: des_8KgLp1vAEz7H.
- `dir` (`string`, optional): Sort direction. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `error_code` (`string`, optional): Filter by error code code. One of: BAD_RESPONSE, CANCELLED, TIMEOUT, NOT_FOUND, CANCELLED_PAST_RETENTION, CONNECTION_REFUSED, CONNECTION_RESET, CONNECTION_TIMEOUT, MISSING_URL, CLI, CLI_UNAVAILABLE, CLI_BINARY_UNSUPPORTED, SELF_SIGNED_CERT, ERR_TLS_CERT_ALTNAME_INVALID, ERR_SSL_WRONG_VERSION_NUMBER, NETWORK_ERROR, NETWORK_REQUEST_CANCELED, NETWORK_UNREACHABLE, TOO_MANY_REDIRECTS, INVALID_CHARACTER, INVALID_URL, SSL_ERROR_CA_UNKNOWN, DATA_ARCHIVED, SSL_CERT_EXPIRED, BULK_RETRY_CANCELLED, DNS_LOOKUP_FAILED, DNS_NO_RECORDS, HOST_UNREACHABLE, INTERNAL_ERROR, PROTOCOL_ERROR, PAYLOAD_MISSING, PAYLOAD_TOO_LARGE, UNABLE_TO_GET_ISSUER_CERT, SOCKET_CLOSED, SQS_BINARY_UNSUPPORTED, SQS_INVALID_MESSAGE_GROUP_ID, SQS_MESSAGE_TOO_LARGE, OAUTH2_HANDSHAKE_FAILED, DESTINATION_AUTH_FAILED, Z_DATA_ERROR, UNKNOWN. Example: TIMEOUT. One of: `BAD_RESPONSE`, `CANCELLED`, `TIMEOUT`, `NOT_FOUND`, `CANCELLED_PAST_RETENTION`, `CONNECTION_REFUSED`, `CONNECTION_RESET`, `CONNECTION_TIMEOUT`, `MISSING_URL`, `CLI`, `CLI_UNAVAILABLE`, `CLI_BINARY_UNSUPPORTED`, `SELF_SIGNED_CERT`, `ERR_TLS_CERT_ALTNAME_INVALID`, `ERR_SSL_WRONG_VERSION_NUMBER`, `NETWORK_ERROR`, `NETWORK_REQUEST_CANCELED`, `NETWORK_UNREACHABLE`, `TOO_MANY_REDIRECTS`, `INVALID_CHARACTER`, `INVALID_URL`, `SSL_ERROR_CA_UNKNOWN`, `DATA_ARCHIVED`, `SSL_CERT_EXPIRED`, `BULK_RETRY_CANCELLED`, `DNS_LOOKUP_FAILED`, `DNS_NO_RECORDS`, `HOST_UNREACHABLE`, `INTERNAL_ERROR`, `PROTOCOL_ERROR`, `PAYLOAD_MISSING`, `PAYLOAD_TOO_LARGE`, `UNABLE_TO_GET_ISSUER_CERT`, `SOCKET_CLOSED`, `SQS_BINARY_UNSUPPORTED`, `SQS_INVALID_MESSAGE_GROUP_ID`, `SQS_MESSAGE_TOO_LARGE`, `OAUTH2_HANDSHAKE_FAILED`, `DESTINATION_AUTH_FAILED`, `Z_DATA_ERROR`, `UNKNOWN`.
- `headers` (`string`, optional): URL Encoded string of the JSON to match to the data headers. Example: {"x-shopify-topic":"orders/create"}
- `include` (`string`, optional): Set to data to include the data object on each event: the request as delivered to the destination (URL, method, path, query, headers and body). Text and JSON bodies are returned in full, so responses can be very large: up to limit events, each with a body up to your plan's maximum payload size. Binary bodies are null, except multipart bodies, which come back with their text fields and a placeholder for each file. Use GET /events/{id}/raw_body for the raw body. Use a small limit, or retrieve a single event with GET /events/{id}. One of: data. Example: data. One of: `data`.
- `last_attempt_at_gte` (`string`, optional): Only include results whose last attempt at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `last_attempt_at_lte` (`string`, optional): Only include results whose last attempt at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `next_attempt_at_gte` (`string`, optional): Only include results whose next attempt at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `next_attempt_at_lte` (`string`, optional): Only include results whose next attempt at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `order_by` (`string`, optional): Sort key. One of: created_at. Example: created_at. One of: `created_at`.
- `parsed_query` (`string`, optional): URL Encoded string of the JSON to match to the parsed query (JSON representation of the query). Example: {"page":"1"}
- `path` (`string`, optional): URL Encoded string of the value to match partially to the path. Example: /webhooks/orders.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `response_status` (`integer`, optional): Filter by HTTP response status code. Example: 500.
- `search_term` (`string`, optional): URL Encoded string of the value to match partially to the body, headers, parsed_query or path. Example: order_id.
- `source_id` (`string`, optional): Filter by source IDs. Example: src_yt8RaJNLxNEP.
- `status` (`string`, optional): Lifecyle status of the event. One of: SCHEDULED, QUEUED, HOLD, SUCCESSFUL, FAILED, CANCELLED. Example: FAILED. One of: `SCHEDULED`, `QUEUED`, `HOLD`, `SUCCESSFUL`, `FAILED`, `CANCELLED`.
- `successful_at_gte` (`string`, optional): Only include results whose successful at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `successful_at_lte` (`string`, optional): Only include results whose successful at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `webhook_id` (`string`, optional): Filter by connection (webhook) IDs. Example: web_UfM8Bmr4zxlW.

Example input: `{"id":"<id>"}`

### `hookdeck_request_get`

Get Request · Read-only

Get one received request by ID. Returns the request with headers, body, parsed query, verification result and counts of events. Use this to inspect what a sender posted.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Request ID. Example: req_ZcR8m2Qp1aLs.

Example input: `{"id":"<id>"}`

### `hookdeck_request_ignored_events_list`

List Request Ignored Events · Read-only

List the ignored events of one request: connections that skipped it because of a filter, a disabled connection or a transformation. Returns ignored event models with cause and webhook_id. Use this to learn why a request produced no delivery.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Request ID. Example: req_ZcR8m2Qp1aLs.
- `dir` (`string`, optional): Sort direction(s). One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key(s). One of: created_at. Example: created_at. One of: `created_at`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.

Example input: `{"id":"<id>"}`

### `hookdeck_requests_list`

List Requests · Read-only

List requests (webhooks received by a source) filtered by status, rejection cause, source, verification, dates or a text search on body, headers or path. Returns models with id, source_id, status, rejection_cause, events_count and timestamps, plus pagination cursors. Use this to see what was received. Use hookdeck_events_list for deliveries.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `body` (`string`, optional): URL Encoded string of the JSON to match to the data body. Example: {"status":"paid"}
- `cli_events_count` (`integer`, optional): Filter by count of CLI events. Example: 0.
- `created_at_gte` (`string`, optional): Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `created_at_lte` (`string`, optional): Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `dir` (`string`, optional): Sort direction. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `events_count` (`integer`, optional): Filter by count of events. Example: 1.
- `headers` (`string`, optional): URL Encoded string of the JSON to match to the data headers. Example: {"x-shopify-topic":"orders/create"}
- `id` (`string`, optional): Filter by requests IDs. Example: web_UfM8Bmr4zxlW.
- `ignored_count` (`integer`, optional): Filter by count of ignored events. Example: 0.
- `include` (`string`, optional): Set to data to include the data object on each request: the original request as received (path, query, headers and body). Text and JSON bodies are returned in full, so responses can be very large: up to limit requests, each with a body up to your plan's maximum payload size. Binary bodies are null, except multipart bodies, which come back with their text fields and a placeholder for each file. Use GET /requests/{id}/raw_body for the raw body. Use a small limit, or retrieve a single request with GET /requests/{id}. One of: data. Example: data. One of: `data`.
- `ingested_at_gte` (`string`, optional): Only include results whose ingested at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `ingested_at_lte` (`string`, optional): Only include results whose ingested at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key. One of: created_at, ingested_at. Example: created_at. One of: `created_at`, `ingested_at`.
- `parsed_query` (`string`, optional): URL Encoded string of the JSON to match to the parsed query (JSON representation of the query). Example: {"page":"1"}
- `path` (`string`, optional): URL Encoded string of the value to match partially to the path. Example: /webhooks/orders.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `rejection_cause` (`string`, optional): Filter by rejection cause. One of: SOURCE_DISABLED, NO_CONNECTION, VERIFICATION_FAILED, UNSUPPORTED_HTTP_METHOD, UNSUPPORTED_CONTENT_TYPE, UNPARSABLE_JSON, PAYLOAD_TOO_LARGE, INGESTION_FATAL, UNKNOWN. Example: VERIFICATION_FAILED. One of: `SOURCE_DISABLED`, `NO_CONNECTION`, `VERIFICATION_FAILED`, `UNSUPPORTED_HTTP_METHOD`, `UNSUPPORTED_CONTENT_TYPE`, `UNPARSABLE_JSON`, `PAYLOAD_TOO_LARGE`, `INGESTION_FATAL`, `UNKNOWN`.
- `search_term` (`string`, optional): URL Encoded string of the value to match partially to the body, headers, parsed_query or path. Example: order_id.
- `source_id` (`string`, optional): Filter by source IDs. Example: src_yt8RaJNLxNEP.
- `status` (`string`, optional): Filter by status. One of: accepted, rejected. Example: accepted. One of: `accepted`, `rejected`.
- `verified` (`boolean`, optional): Filter by verification status. Example: true.

Example input: `{}`

### `hookdeck_source_get`

Get Source · Read-only

Get one source by ID. Returns the source with its type, ingestion url and config. Use this when you know the ID. Use hookdeck_sources_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Source ID. Example: src_yt8RaJNLxNEP.
- `include` (`string`, optional): include. One of: config.auth. Example: config.auth. One of: `config.auth`.

Example input: `{"id":"<id>"}`

### `hookdeck_sources_list`

List Sources · Read-only

List sources (the endpoints that receive webhooks) in the project, filtered by ID, name or disabled state. Returns models with id, name, type, url and config, plus pagination cursors. Use this to browse sources. Use hookdeck_source_get for one source.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dir` (`string`, optional): Sort direction. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `disabled` (`boolean`, optional): Include disabled resources in the response. Example: true.
- `disabled_at_gte` (`string`, optional): Only include results whose disabled at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `disabled_at_lte` (`string`, optional): Only include results whose disabled at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `id` (`string`, optional): Filter by source IDs. Example: web_UfM8Bmr4zxlW.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `name` (`string`, optional): The source name. Example: shopify.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key. One of: name, created_at, updated_at. Example: name. One of: `name`, `created_at`, `updated_at`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `type` (`string`, optional): Filter by source type. Example: WEBHOOK.

Example input: `{}`

### `hookdeck_transformation_executions_list`

List Transformation Executions · Read-only

List executions of a transformation, filtered by log level, connection, issue or date. Returns models with id, log_level, logs, webhook_id and timestamps. Use this to debug a transformation in production.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Transformation ID. Example: trs_m9Jf3dK7pQ2a.
- `created_at_gte` (`string`, optional): Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
- `created_at_lte` (`string`, optional): Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
- `dir` (`string`, optional): Sort direction(s). One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `issue_id` (`string`, optional): ID of the associated issue. Example: iss_Qn4Lp8sT2w1x.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `log_level` (`string`, optional): Log level of the execution. One of: debug, info, warn, error, fatal. Example: error. One of: `debug`, `info`, `warn`, `error`, `fatal`.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key(s). One of: created_at. Example: created_at. One of: `created_at`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
- `webhook_id` (`string`, optional): ID of the connection the execution was run for. Example: web_UfM8Bmr4zxlW.

Example input: `{"id":"<id>"}`

### `hookdeck_transformation_get`

Get Transformation · Read-only

Get one transformation by ID. Returns the transformation with its code and environment variables. Use this to read the code.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Transformation ID. Example: trs_m9Jf3dK7pQ2a.

Example input: `{"id":"<id>"}`

### `hookdeck_transformation_test`

Test Transformation · Read-only

Run transformation code (or a saved transformation) against a sample request without saving anything. Returns the transformed request and console logs. Use this to try code before hookdeck_transformation_create or _update.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `code` (`string`, optional): JavaScript code to be executed. Example: addHandler('transform', (request, context) => { request.headers['x-env'] = 'test'; return request; });.
- `env` (`object`, optional): Key-value environment variables to be passed to the transformation. Example: {"API_ENV":"test"}
- `event_data_id` (`string`, optional): Sample payload to run against: a request's or execution's original_event_data_id. Multipart samples are presented the way the connection given by webhook_id receives them. When request is also provided it is used as the input, and the sample supplies the original multipart bytes. Example: edt_0c7b5BkAn3kq.
- `request` (`object`, optional): Request input to use for the transformation execution. Example: {"headers":{"content-type":"application/json"},"body":{"status":"paid"}}
- `transformation_id` (`string`, optional): Transformation ID. Example: trs_m9Jf3dK7pQ2a.
- `webhook_id` (`string`, optional): ID of the connection (webhook) to use for the execution context. Example: web_UfM8Bmr4zxlW.

Example input: `{}`

### `hookdeck_transformations_list`

List Transformations · Read-only

List transformations (JavaScript that rewrites requests before delivery). Returns models with id, name, code, env and timestamps. Use this to browse. Use hookdeck_transformation_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dir` (`string`, optional): Sort direction. One of: asc, desc. Example: asc. One of: `asc`, `desc`.
- `id` (`string`, optional): Filter by transformation IDs. Example: web_UfM8Bmr4zxlW.
- `limit` (`integer`, optional): Result set size. Example: 25.
- `name` (`string`, optional): Filter by transformation name. Example: sk-test-add-header.
- `next` (`string`, optional): The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
- `order_by` (`string`, optional): Sort key. One of: name, created_at, updated_at. Example: created_at. One of: `name`, `created_at`, `updated_at`.
- `prev` (`string`, optional): The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.

Example input: `{}`

### `hookdeck_bookmark_create`

Create Bookmark · Write

Bookmark a request's payload (by event_data_id) for a connection so it can be replayed later. Returns the created bookmark. Use this to save a payload for testing. Use hookdeck_bookmark_trigger to send it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `event_data_id` (`string`, required): ID of the event data to bookmark. Example: edt_0c7b5BkAn3kq.
- `label` (`string`, required): Descriptive name of the bookmark. Example: sk-test failed order webhook.
- `webhook_id` (`string`, required): ID of the associated connection (webhook). Example: web_UfM8Bmr4zxlW.
- `name` (`string`, optional): A unique, human-friendly name for the bookmark. Example: sk-test-orders.

Example input: `{"event_data_id":"<event_data_id>","label":"<label>","webhook_id":"<webhook_id>"}`

### `hookdeck_bookmark_trigger`

Trigger Bookmark · Write

Replay a bookmarked payload through its connection, creating and delivering new events. Returns the events created. Use this to resend a saved payload to the destination.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Bookmark ID. Example: bmk_2Xc8Lm4pQ9sT.

Example input: `{"id":"<id>"}`

### `hookdeck_connection_create`

Create Connection · Write

Create a connection between a source and a destination, using existing IDs or new inline source and destination objects, with optional retry, filter, transform, delay and deduplicate rules. Returns the created connection. Use this to start routing webhooks. Use hookdeck_connection_update to change an existing one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, optional): Description for the connection. Example: Order webhooks from Shopify.
- `destination` (`object`, optional): Destination input object. Example: {"name":"sk-test-api","type":"HTTP","config":{"url":"https://example.com/webhooks"}}
- `destination_id` (`string`, optional): ID of a destination to bind to the connection. Example: des_8KgLp1vAEz7H.
- `name` (`string`, optional): A unique name of the connection for the source. Example: sk-test-orders.
- `rules` (`array`, optional): Rules to apply to the connection. Filter, transform and deduplicate rules run in array order. Example: [{"type":"retry","strategy":"exponential","count":5,"interval":60000}]
- `source` (`object`, optional): Source input object. Example: {"name":"sk-test-shopify","type":"WEBHOOK"}
- `source_id` (`string`, optional): ID of a source to bind to the connection. Example: src_yt8RaJNLxNEP.

Example input: `{}`

### `hookdeck_connection_disable`

Disable Connection · Write

Disable a connection: new events for it are not created. Returns the connection with disabled_at set. Use this to stop a connection without deleting it. Use hookdeck_connection_enable to turn it back on.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Connection ID. Example: web_UfM8Bmr4zxlW.

Example input: `{"id":"<id>"}`

### `hookdeck_connection_enable`

Enable Connection · Write

Enable a disabled connection. Returns the connection with disabled_at cleared. Use this after hookdeck_connection_disable.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Connection ID. Example: web_UfM8Bmr4zxlW.

Example input: `{"id":"<id>"}`

### `hookdeck_connection_pause`

Pause Connection · Write

Pause a connection: Hookdeck keeps accepting events but holds them until the connection is unpaused. Returns the connection with paused_at set. Use this to hold deliveries during maintenance. Use hookdeck_connection_unpause to resume.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Connection ID. Example: web_UfM8Bmr4zxlW.

Example input: `{"id":"<id>"}`

### `hookdeck_connection_unpause`

Unpause Connection · Write

Unpause a connection so held events are delivered. Returns the connection with paused_at cleared. Use this after hookdeck_connection_pause.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Connection ID. Example: web_UfM8Bmr4zxlW.

Example input: `{"id":"<id>"}`

### `hookdeck_connection_update`

Update Connection · Write

Update a connection's name, description or rules. Returns the updated connection. Use this to change rules. Use hookdeck_connection_pause to hold deliveries instead.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Connection ID. Example: web_UfM8Bmr4zxlW.
- `description` (`string`, optional): Description for the connection. Example: Order webhooks from Shopify.
- `name` (`string`, optional): name. Example: sk-test-orders.
- `rules` (`array`, optional): Rules to apply to the connection. Filter, transform and deduplicate rules run in array order. Example: [{"type":"retry","strategy":"exponential","count":5,"interval":60000}]

Example input: `{"id":"<id>"}`

### `hookdeck_destination_create`

Create Destination · Write

Create a destination: an HTTP endpoint, the Hookdeck CLI, a mock API or an SQS queue, with optional rate limit and auth config. Returns the created destination. Use this to add a delivery target. Use hookdeck_connection_create to route a source to it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name for the destination. Example: sk-test-orders.
- `config` (`object`, optional): The type configs for the specified type. Example: {"url":"https://example.com/webhooks"}
- `description` (`string`, optional): Description for the destination. Example: Order webhooks from Shopify.
- `type` (`string`, optional): Type of the destination. One of: HTTP, CLI, MOCK_API, SQS. Example: HTTP. One of: `HTTP`, `CLI`, `MOCK_API`, `SQS`.

Example input: `{"name":"<name>"}`

### `hookdeck_destination_disable`

Disable Destination · Write

Disable a destination so no events are delivered to it. Returns the destination with disabled_at set. Use hookdeck_destination_enable to turn it back on.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Destination ID. Example: des_8KgLp1vAEz7H.

Example input: `{"id":"<id>"}`

### `hookdeck_destination_enable`

Enable Destination · Write

Enable a disabled destination. Returns the destination with disabled_at cleared. Use this after hookdeck_destination_disable.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Destination ID. Example: des_8KgLp1vAEz7H.

Example input: `{"id":"<id>"}`

### `hookdeck_destination_update`

Update Destination · Write

Update a destination's name, type, description or config. Returns the updated destination. Use this to change a URL, rate limit or auth on an existing destination.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Destination ID. Example: des_8KgLp1vAEz7H.
- `config` (`object`, optional): The type configs for the specified type. Example: {"url":"https://example.com/webhooks"}
- `description` (`string`, optional): Description for the destination. Example: Order webhooks from Shopify.
- `name` (`string`, optional): Name for the destination. Example: sk-test-orders.
- `type` (`string`, optional): Type of the destination. One of: HTTP, CLI, MOCK_API, SQS. Example: HTTP. One of: `HTTP`, `CLI`, `MOCK_API`, `SQS`.

Example input: `{"id":"<id>"}`

### `hookdeck_event_cancel`

Cancel Event · Write

Cancel all future automatic retries of an event. Returns the event. Use this to stop retrying a delivery that will never succeed. Use hookdeck_event_mute to also hide it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Event ID. Example: evt_3fWxkUC9jw0aRS.

Example input: `{"id":"<id>"}`

### `hookdeck_event_mute`

Mute Event · Write

Mute an event: cancel its scheduled retries and stop it from counting toward issues. Returns the event. Use this for known-bad events. Use hookdeck_event_cancel to only stop retries.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Event ID. Example: evt_3fWxkUC9jw0aRS.

Example input: `{"id":"<id>"}`

### `hookdeck_event_retry`

Retry Event · Write

Retry delivery of one event now. Returns the event and the new attempt. Use this for a single failed event. Use hookdeck_events_bulk_retry_create for many.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Event ID. Example: evt_3fWxkUC9jw0aRS.

Example input: `{"id":"<id>"}`

### `hookdeck_events_bulk_retry_create`

Bulk Retry Events · Write

Start a bulk retry of every event matching a query (the same filters as hookdeck_events_list, e.g. status and webhook_id). Returns the bulk retry with its id, estimated count and progress. Use this after a destination outage. Use hookdeck_event_retry for one event.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `query` (`object`, optional): Filter properties for the events to be included in the bulk retry. Example: {"status":"FAILED","webhook_id":"web_UfM8Bmr4zxlW"}

Example input: `{}`

### `hookdeck_issue_trigger_create`

Create Issue Trigger · Write

Create an issue trigger for delivery, transformation, backpressure or request issues and choose its notification channels. Returns the created trigger. Use this to set up alerting. Use hookdeck_issue_trigger_update to change one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `channels` (`object`, required): Notification channels object for the specific channel type. Example: {"email":{}}
- `type` (`string`, required): Issue type. Example: delivery.
- `configs` (`object`, optional): Configuration object for the specific issue type selected. Example: {"strategy":"first_attempt","connections":"*"}
- `name` (`string`, optional): Optional unique name to use as reference when using the API. Example: sk-test-delivery-alerts.

Example input: `{"channels":{},"type":"<type>"}`

### `hookdeck_issue_trigger_update`

Update Issue Trigger · Write

Update an issue trigger's name, configs or channels. Returns the updated trigger. Use this to change alert conditions or recipients.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Issue trigger ID. Example: it_BXBPmXR5tE1V.
- `channels` (`object`, optional): Notification channels object for the specific channel type. Example: {"email":{}}
- `configs` (`object`, optional): Configuration object for the specific issue type selected. Example: {"strategy":"first_attempt","connections":"*"}
- `disabled_at` (`string`, optional): Date when the issue trigger was disabled. Example: 2026-01-01T00:00:00Z.
- `name` (`string`, optional): Optional unique name to use as reference when using the API. Example: sk-test-delivery-alerts.

Example input: `{"id":"<id>"}`

### `hookdeck_issue_update`

Update Issue Status · Write

Set an issue's status to OPENED, ACKNOWLEDGED, RESOLVED or IGNORED. Returns the updated issue. Use this to acknowledge or resolve. Use hookdeck_issue_dismiss to dismiss it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Issue ID. Example: iss_Qn4Lp8sT2w1x.
- `status` (`string`, required): New status. One of: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED. Example: ACKNOWLEDGED. One of: `OPENED`, `IGNORED`, `ACKNOWLEDGED`, `RESOLVED`.

Example input: `{"id":"<id>","status":"OPENED"}`

### `hookdeck_request_retry`

Retry Request · Write

Re-process a received request through the current connections and rules, creating new events for the given connections. Returns the request and the events created. Use this after fixing a rule or adding a connection. Use hookdeck_event_retry to redeliver an existing event.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Request ID. Example: req_ZcR8m2Qp1aLs.
- `webhook_ids` (`array`, optional): Subset of connection (webhook) IDs to re-run the event logic on. Useful to retry only specific ignored_events. If left empty, all connection (webhook) IDs will be considered. Example: ["web_UfM8Bmr4zxlW"]

Example input: `{"id":"<id>"}`

### `hookdeck_source_create`

Create Source · Write

Create a source: a Hookdeck URL that receives webhooks of a given type (WEBHOOK, HTTP or a named provider such as STRIPE or SHOPIFY) with optional verification config. Returns the created source, including the url to give the sender. Use this to add an ingestion endpoint. Use hookdeck_connection_create to wire it to a destination.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): A unique name for the source. Example: sk-test-orders.
- `config` (`object`, optional): The type configs for the specified type. Example: {"allowed_http_methods":["POST"]}
- `description` (`string`, optional): Description for the source. Example: Order webhooks from Shopify.
- `type` (`string`, optional): Source type: WEBHOOK, HTTP or a provider name in upper case such as STRIPE, SHOPIFY, GITHUB or TWILIO (see the Hookdeck source types reference). Defaults to WEBHOOK. Example: WEBHOOK.

Example input: `{"name":"<name>"}`

### `hookdeck_source_disable`

Disable Source · Write

Disable a source so it rejects incoming requests. Returns the source with disabled_at set. Use hookdeck_source_enable to turn it back on.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Source ID. Example: src_yt8RaJNLxNEP.

Example input: `{"id":"<id>"}`

### `hookdeck_source_enable`

Enable Source · Write

Enable a disabled source. Returns the source with disabled_at cleared. Use this after hookdeck_source_disable.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Source ID. Example: src_yt8RaJNLxNEP.

Example input: `{"id":"<id>"}`

### `hookdeck_source_update`

Update Source · Write

Update a source's name, type, description or config. Returns the updated source. Use this to change verification or allowed methods on an existing source.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Source ID. Example: src_yt8RaJNLxNEP.
- `config` (`object`, optional): The type configs for the specified type. Example: {"allowed_http_methods":["POST"]}
- `description` (`string`, optional): Description for the source. Example: Order webhooks from Shopify.
- `name` (`string`, optional): A unique name for the source. Example: sk-test-orders.
- `type` (`string`, optional): Source type: WEBHOOK, HTTP or a provider name in upper case such as STRIPE, SHOPIFY, GITHUB or TWILIO. Example: WEBHOOK.

Example input: `{"id":"<id>"}`

### `hookdeck_transformation_create`

Create Transformation · Write

Create a transformation from JavaScript code that calls addHandler('transform', ...), with optional environment variables. Returns the created transformation. Use hookdeck_transformation_test first to try the code. Add it to a connection with a transform rule.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): JavaScript code to be executed as string. Example: addHandler('transform', (request, context) => { request.headers['x-env'] = 'test'; return request; });.
- `name` (`string`, required): A unique, human-friendly name for the transformation. Example: sk-test-add-header.
- `env` (`object`, optional): Key-value environment variables to be passed to the transformation. Example: {"API_ENV":"test"}

Example input: `{"code":"<code>","name":"<name>"}`

### `hookdeck_transformation_update`

Update Transformation · Write

Update a transformation's name, code or environment variables. Returns the updated transformation. Use this to change code. Use hookdeck_transformation_test to try it first.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Transformation ID. Example: trs_m9Jf3dK7pQ2a.
- `code` (`string`, optional): JavaScript code to be executed. Example: addHandler('transform', (request, context) => { request.headers['x-env'] = 'test'; return request; });.
- `env` (`object`, optional): Key-value environment variables to be passed to the transformation. Example: {"API_ENV":"test"}
- `name` (`string`, optional): A unique, human-friendly name for the transformation. Example: sk-test-add-header.

Example input: `{"id":"<id>"}`

### `hookdeck_bookmark_delete`

Delete Bookmark · Destructive

Delete a bookmark. Returns the deleted bookmark's ID. Use this to remove a saved payload.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Bookmark ID. Example: bmk_2Xc8Lm4pQ9sT.

Example input: `{"id":"<id>"}`

### `hookdeck_connection_delete`

Delete Connection · Destructive

Permanently delete a connection. Returns the deleted connection's ID. Use this to remove routing. Use hookdeck_connection_disable to stop it while keeping it.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): id. Example: web_UfM8Bmr4zxlW.

Example input: `{"id":"<id>"}`

### `hookdeck_destination_delete`

Delete Destination · Destructive

Permanently delete a destination. Returns the deleted destination's ID. Use hookdeck_destination_disable to stop deliveries but keep it.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): id. Example: des_8KgLp1vAEz7H.

Example input: `{"id":"<id>"}`

### `hookdeck_issue_dismiss`

Dismiss Issue · Destructive

Dismiss an issue. Returns the issue with dismissed_at set. Use this to clear an issue. Use hookdeck_issue_update to change its status instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Issue ID. Example: iss_Qn4Lp8sT2w1x.

Example input: `{"id":"<id>"}`

### `hookdeck_issue_trigger_delete`

Delete Issue Trigger · Destructive

Delete an issue trigger. Returns the deleted trigger's ID. Use this to remove an alert rule.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Issue trigger ID. Example: it_BXBPmXR5tE1V.

Example input: `{"id":"<id>"}`

### `hookdeck_source_delete`

Delete Source · Destructive

Permanently delete a source. Returns the deleted source's ID. Use this to remove an endpoint. Use hookdeck_source_disable to stop accepting requests but keep it.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): id. Example: src_yt8RaJNLxNEP.

Example input: `{"id":"<id>"}`

### `hookdeck_transformation_delete`

Delete Transformation · Destructive

Delete a transformation. Returns the deleted transformation's ID. Use this to remove unused code.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Transformation ID. Example: trs_m9Jf3dK7pQ2a.

Example input: `{"id":"<id>"}`

## Related

Other Developer Tools connectors ([all 200](/agentkit/connectors/?category=developer-tools)):

- [GitHub](/agentkit/connectors/github/): Scalekit connector, OAuth, 217 tools
- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
