Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Hookdeck

Scalekit connector
Open markdown

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.

Tools
60
What they doRead · write · destructive
27 · 26 · 727 read26 write7 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .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.

  4. Authorize a user and make your first call

    quickstart.mts
    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)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Hookdeck credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • hookdeck_attempt_getGet one delivery attempt by ID.Read-only

    Get Attempt

    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.

    Inputs

    idstringrequired
    Attempt ID. Example: atm_7YtqvL2c9NeF.
  • hookdeck_attempts_listList delivery attempts, usually for one event.Read-only

    List Attempts

    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.

    Inputs

    dirstring
    Sort direction(s). One of: asc, desc. Example: asc.one of ascdesc
    event_idstring
    Event the attempt is associated with. Example: evt_3fWxkUC9jw0aRS.
    idstring
    ID of the attempt. Example: web_UfM8Bmr4zxlW.
    limitinteger
    Result set size. Example: 25.
    nextstring
    The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
    order_bystring
    Sort key(s). One of: created_at. Example: created_at.one of created_at
    prevstring
    The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
  • hookdeck_bookmark_getGet one bookmark by ID.Read-only

    Get Bookmark

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

    Inputs

    idstringrequired
    Bookmark ID. Example: bmk_2Xc8Lm4pQ9sT.
  • hookdeck_bookmarks_listList bookmarks (saved request payloads that can be replayed to a connection).Read-only

    List Bookmarks

    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.

    Inputs

    dirstring
    Sort direction(s). One of: asc, desc. Example: asc.one of ascdesc
    event_data_idstring
    Filter by associated event data ID. Example: edt_0c7b5BkAn3kq.
    idstring
    Filter by bookmark IDs. Example: web_UfM8Bmr4zxlW.
    labelstring
    Filter by label. Example: sk-test failed order webhook.
    last_used_at_gtestring
    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_ltestring
    Only include results whose last used at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
    limitinteger
    Result set size. Example: 25.
    namestring
    Filter by bookmark name. Example: sk-test-orders.
    nextstring
    The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
    order_bystring
    Sort key(s). One of: created_at. Example: created_at.one of created_at
    prevstring
    The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
    webhook_idstring
    Filter by associated connection (webhook) ID. Example: web_UfM8Bmr4zxlW.
  • hookdeck_connection_getGet one connection by ID.Read-only

    Get Connection

    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.

    Inputs

    idstringrequired
    Connection ID. Example: web_UfM8Bmr4zxlW.
  • hookdeck_connections_listList connections (a source wired to a destination, with rules) in the project, filtered by name, source, destination or disabled state.Read-only

    List Connections

    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.

    Inputs

    destination_idstring
    Filter by associated destination IDs. Example: des_8KgLp1vAEz7H.
    dirstring
    Sort direction(s). One of: asc, desc. Example: asc.one of ascdesc
    disabledboolean
    Include disabled resources in the response. Example: true.
    disabled_at_gtestring
    Only include results whose disabled at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
    disabled_at_ltestring
    Only include results whose disabled at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
    full_namestring
    Fuzzy match the concatenated source and connection name. The source name and connection name must be separated by " -> ". Example: shopify > orders-api.
    idstring
    Filter by connection IDs. Example: web_UfM8Bmr4zxlW.
    limitinteger
    Result set size. Example: 25.
    namestring
    Filter by connection name. Example: orders-api.
    nextstring
    The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
    order_bystring
    Sort key(s). One of: full_name, created_at, updated_at. Example: created_at.one of full_namecreated_atupdated_at
    paused_at_gtestring
    Only include results whose paused at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
    paused_at_ltestring
    Only include results whose paused at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
    prevstring
    The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
    source_idstring
    Filter by associated source IDs. Example: src_yt8RaJNLxNEP.
  • hookdeck_destination_getGet one destination by ID.Read-only

    Get Destination

    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.

    Inputs

    idstringrequired
    Destination ID. Example: des_8KgLp1vAEz7H.
    includestring
    include. One of: config.auth. Example: config.auth.one of config.auth
  • hookdeck_destinations_listList destinations (where Hookdeck delivers events) in the project, filtered by ID, name, type or disabled state.Read-only

    List Destinations

    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.

    Inputs

    dirstring
    Sort direction. One of: asc, desc. Example: asc.one of ascdesc
    disabledboolean
    Include disabled resources in the response. Example: true.
    disabled_at_gtestring
    Only include results whose disabled at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
    disabled_at_ltestring
    Only include results whose disabled at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
    idstring
    Filter by destination IDs. Example: web_UfM8Bmr4zxlW.
    limitinteger
    Result set size. Example: 25.
    namestring
    The destination name. Example: orders-api.
    nextstring
    The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
    order_bystring
    Sort key. One of: name, created_at, updated_at. Example: name.one of namecreated_atupdated_at
    prevstring
    The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
    typestring
    Filter by destination type. One of: HTTP, CLI, MOCK_API, SQS. Example: HTTP.one of HTTPCLIMOCK_APISQS