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
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Hookdeck connection
In AgentKit > Connections, create a Hookdeck connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'hookdeck'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'hookdeck_attempts_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "hookdeck"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="hookdeck_attempts_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toolhookdeck_attempt_getGet one delivery attempt by ID.Read-onlyGet 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-onlyList 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-onlyGet 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-onlyList 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-onlyGet 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-onlyList 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-onlyGet 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-onlyList 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
hookdeck_event_getGet one event by ID.Read-onlyGet Event
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.
Inputs
idstringrequired- Event ID. Example: evt_3fWxkUC9jw0aRS.
hookdeck_events_listList 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.Read-onlyList Events
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.
Inputs
attemptsinteger- Filter by number of attempts. Example: 3.
bodystring- URL Encoded string of the JSON to match to the data body. Example: {"status":"paid"}
cli_idstring- Filter by CLI IDs. ?[any]=true operator for any CLI. Example: cl_5bFpQ3n8sKx2.
created_at_gtestring- Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
created_at_ltestring- Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
delivery_groupstring- Filter by delivery group; null matches events without a delivery group. Example: orders.
destination_idstring- Filter by destination IDs. Example: des_8KgLp1vAEz7H.
dirstring- Sort direction. One of: asc, desc. Example: asc.one of
ascdesc error_codestring- 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_RESPONSECANCELLEDTIMEOUTNOT_FOUNDCANCELLED_PAST_RETENTIONCONNECTION_REFUSEDCONNECTION_RESETCONNECTION_TIMEOUTMISSING_URLCLICLI_UNAVAILABLECLI_BINARY_UNSUPPORTEDSELF_SIGNED_CERTERR_TLS_CERT_ALTNAME_INVALIDERR_SSL_WRONG_VERSION_NUMBERNETWORK_ERRORNETWORK_REQUEST_CANCELEDNETWORK_UNREACHABLETOO_MANY_REDIRECTSINVALID_CHARACTERINVALID_URLSSL_ERROR_CA_UNKNOWNDATA_ARCHIVEDSSL_CERT_EXPIREDBULK_RETRY_CANCELLEDDNS_LOOKUP_FAILEDDNS_NO_RECORDSHOST_UNREACHABLEINTERNAL_ERRORPROTOCOL_ERRORPAYLOAD_MISSINGPAYLOAD_TOO_LARGEUNABLE_TO_GET_ISSUER_CERTSOCKET_CLOSEDSQS_BINARY_UNSUPPORTEDSQS_INVALID_MESSAGE_GROUP_IDSQS_MESSAGE_TOO_LARGEOAUTH2_HANDSHAKE_FAILEDDESTINATION_AUTH_FAILEDZ_DATA_ERRORUNKNOWN headersstring- URL Encoded string of the JSON to match to the data headers. Example: {"x-shopify-topic":"orders/create"}
idstring- Filter by event IDs. Example: web_UfM8Bmr4zxlW.
includestring- 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_gtestring- 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_ltestring- Only include results whose last attempt at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
limitinteger- Result set size. Example: 25.
nextstring- The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
next_attempt_at_gtestring- 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_ltestring- Only include results whose next attempt at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
order_bystring- Sort key. One of: created_at. Example: created_at.one of
created_at parsed_querystring- URL Encoded string of the JSON to match to the parsed query (JSON representation of the query). Example: {"page":"1"}
pathstring- URL Encoded string of the value to match partially to the path. Example: /webhooks/orders.
prevstring- The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
response_statusinteger- Filter by HTTP response status code. Example: 500.
search_termstring- URL Encoded string of the value to match partially to the body, headers, parsed_query or path. Example: order_id.
source_idstring- Filter by source IDs. Example: src_yt8RaJNLxNEP.
statusstring- Lifecyle status of the event. One of: SCHEDULED, QUEUED, HOLD, SUCCESSFUL, FAILED, CANCELLED. Example: FAILED.one of
SCHEDULEDQUEUEDHOLDSUCCESSFULFAILEDCANCELLED successful_at_gtestring- Only include results whose successful at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
successful_at_ltestring- Only include results whose successful at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
webhook_idstring- Filter by connection (webhook) IDs. Example: web_UfM8Bmr4zxlW.
hookdeck_issue_getGet one issue by ID.Read-onlyGet Issue
Get one issue by ID. Returns the issue with type, status, aggregation keys, reference and timestamps. Use this when you know the ID.
Inputs
idstringrequired- Issue ID. Example: iss_Qn4Lp8sT2w1x.
hookdeck_issue_trigger_getGet one issue trigger by ID.Read-onlyGet Issue Trigger
Get one issue trigger by ID. Returns the trigger with its type, configs and channels. Use this when you know the ID.
Inputs
idstringrequired- Issue trigger ID. Example: it_BXBPmXR5tE1V.
hookdeck_issue_triggers_listList issue triggers (rules that open issues and notify email, Slack, Microsoft Teams or other channels).Read-onlyList Issue Triggers
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.
Inputs
dirstring- Sort direction(s). One of: asc, desc. Example: asc.one of
ascdesc 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.
limitinteger- Result set size. Example: 25.
namestring- Filter by issue trigger name. Example: sk-test-delivery-alerts.
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, type. Example: created_at.one of
created_attype prevstring- The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
typestring- Issue type. Example: delivery.
hookdeck_issues_countCount issues matching the same filters as hookdeck_issues_list.Read-onlyCount Issues
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.
Inputs
aggregation_keysobject- Filter by aggregation keys. Example: {"webhook_id":["web_UfM8Bmr4zxlW"]}
created_at_gtestring- Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
created_at_ltestring- Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
dirstring- Sort direction(s). One of: asc, desc. Example: asc.one of
ascdesc dismissed_at_gtestring- Only include results whose dismissed at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
dismissed_at_ltestring- Only include results whose dismissed at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
first_seen_at_gtestring- 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_ltestring- Only include results whose first seen at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
idstring- Filter by Issue IDs. Example: iss_Qn4Lp8sT2w1x.
issue_trigger_idstring- Filter by Issue trigger IDs. Example: it_BXBPmXR5tE1V.
last_seen_at_gtestring- 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_ltestring- Only include results whose last seen at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
limitinteger- Result set size. Example: 25.
merged_withstring- Filter by Merged Issue IDs. Example: iss_Qn4Lp8sT2w1x.
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, first_seen_at, last_seen_at, opened_at, status. Example: last_seen_at.one of
created_atfirst_seen_atlast_seen_atopened_atstatus prevstring- The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
statusstring- Filter by Issue statuses. One of: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED. Example: OPENED.one of
OPENEDIGNOREDACKNOWLEDGEDRESOLVED typestring- Filter by Issue types. Example: delivery.
hookdeck_issues_listList issues (grouped delivery, transformation, backpressure or request failures) filtered by type, status, trigger and dates.Read-onlyList Issues
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.
Inputs
aggregation_keysobject- Filter by aggregation keys. Example: {"webhook_id":["web_UfM8Bmr4zxlW"]}
created_at_gtestring- Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
created_at_ltestring- Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
dirstring- Sort direction(s). One of: asc, desc. Example: asc.one of
ascdesc dismissed_at_gtestring- Only include results whose dismissed at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
dismissed_at_ltestring- Only include results whose dismissed at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
first_seen_at_gtestring- 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_ltestring- Only include results whose first seen at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
idstring- Filter by Issue IDs. Example: iss_Qn4Lp8sT2w1x.
issue_trigger_idstring- Filter by Issue trigger IDs. Example: it_BXBPmXR5tE1V.
last_seen_at_gtestring- 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_ltestring- Only include results whose last seen at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
limitinteger- Result set size. Example: 25.
merged_withstring- Filter by Merged Issue IDs. Example: iss_Qn4Lp8sT2w1x.
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, first_seen_at, last_seen_at, opened_at, status. Example: last_seen_at.one of
created_atfirst_seen_atlast_seen_atopened_atstatus prevstring- The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
statusstring- Filter by Issue statuses. One of: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED. Example: OPENED.one of
OPENEDIGNOREDACKNOWLEDGEDRESOLVED typestring- Filter by Issue types. Example: delivery.
hookdeck_metrics_events_queryQuery event delivery metrics over a time range, bucketed by granularity and optionally grouped by connection, destination, status or error code.Read-onlyQuery Event Metrics
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.
Inputs
date_range_endstringrequired- End of the time range, ISO 8601 date-time. Example: 2026-01-02T00:00:00Z.
date_range_startstringrequired- Start of the time range, ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
dimensionsarray- Dimensions to group by. Example: ["webhook_id"]
filter_webhook_idstring- Only count data for this connection ID. Example: web_UfM8Bmr4zxlW.
granularitystring- 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.
measuresarray- Measures to return, e.g. count, successful_count, failed_count, error_rate, avg_attempts. Example: ["count"]
hookdeck_metrics_requests_queryQuery received-request metrics over a time range, bucketed by granularity and optionally grouped by source or rejection cause.Read-onlyQuery Request Metrics
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.
Inputs
date_range_endstringrequired- End of the time range, ISO 8601 date-time. Example: 2026-01-02T00:00:00Z.
date_range_startstringrequired- Start of the time range, ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
dimensionsarray- Dimensions to group by. Example: ["source_id"]
filter_source_idstring- Only count data for this source ID. Example: src_yt8RaJNLxNEP.
granularitystring- 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.
measuresarray- Measures to return, e.g. count, accepted_count, rejected_count, discarded_count, avg_events_per_request. Example: ["count"]
hookdeck_request_events_listList the events created from one request.Read-onlyList Request Events
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.
Inputs
idstringrequired- Request ID. Example: req_ZcR8m2Qp1aLs.
attemptsinteger- Filter by number of attempts. Example: 3.
bodystring- URL Encoded string of the JSON to match to the data body. Example: {"status":"paid"}
cli_idstring- Filter by CLI IDs. ?[any]=true operator for any CLI. Example: cl_5bFpQ3n8sKx2.
created_at_gtestring- Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
created_at_ltestring- Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
delivery_groupstring- Filter by delivery group; null matches events without a delivery group. Example: orders.
destination_idstring- Filter by destination IDs. Example: des_8KgLp1vAEz7H.
dirstring- Sort direction. One of: asc, desc. Example: asc.one of
ascdesc error_codestring- 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_RESPONSECANCELLEDTIMEOUTNOT_FOUNDCANCELLED_PAST_RETENTIONCONNECTION_REFUSEDCONNECTION_RESETCONNECTION_TIMEOUTMISSING_URLCLICLI_UNAVAILABLECLI_BINARY_UNSUPPORTEDSELF_SIGNED_CERTERR_TLS_CERT_ALTNAME_INVALIDERR_SSL_WRONG_VERSION_NUMBERNETWORK_ERRORNETWORK_REQUEST_CANCELEDNETWORK_UNREACHABLETOO_MANY_REDIRECTSINVALID_CHARACTERINVALID_URLSSL_ERROR_CA_UNKNOWNDATA_ARCHIVEDSSL_CERT_EXPIREDBULK_RETRY_CANCELLEDDNS_LOOKUP_FAILEDDNS_NO_RECORDSHOST_UNREACHABLEINTERNAL_ERRORPROTOCOL_ERRORPAYLOAD_MISSINGPAYLOAD_TOO_LARGEUNABLE_TO_GET_ISSUER_CERTSOCKET_CLOSEDSQS_BINARY_UNSUPPORTEDSQS_INVALID_MESSAGE_GROUP_IDSQS_MESSAGE_TOO_LARGEOAUTH2_HANDSHAKE_FAILEDDESTINATION_AUTH_FAILEDZ_DATA_ERRORUNKNOWN headersstring- URL Encoded string of the JSON to match to the data headers. Example: {"x-shopify-topic":"orders/create"}
includestring- 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_gtestring- 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_ltestring- Only include results whose last attempt at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
limitinteger- Result set size. Example: 25.
nextstring- The ID to provide in the query to get the next set of results. Example: evt_3fWxkUC9jw0aRS.
next_attempt_at_gtestring- 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_ltestring- Only include results whose next attempt at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
order_bystring- Sort key. One of: created_at. Example: created_at.one of
created_at parsed_querystring- URL Encoded string of the JSON to match to the parsed query (JSON representation of the query). Example: {"page":"1"}
pathstring- URL Encoded string of the value to match partially to the path. Example: /webhooks/orders.
prevstring- The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
response_statusinteger- Filter by HTTP response status code. Example: 500.
search_termstring- URL Encoded string of the value to match partially to the body, headers, parsed_query or path. Example: order_id.
source_idstring- Filter by source IDs. Example: src_yt8RaJNLxNEP.
statusstring- Lifecyle status of the event. One of: SCHEDULED, QUEUED, HOLD, SUCCESSFUL, FAILED, CANCELLED. Example: FAILED.one of
SCHEDULEDQUEUEDHOLDSUCCESSFULFAILEDCANCELLED successful_at_gtestring- Only include results whose successful at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
successful_at_ltestring- Only include results whose successful at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
webhook_idstring- Filter by connection (webhook) IDs. Example: web_UfM8Bmr4zxlW.
hookdeck_request_getGet one received request by ID.Read-onlyGet Request
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.
Inputs
idstringrequired- Request ID. Example: req_ZcR8m2Qp1aLs.
hookdeck_request_ignored_events_listList the ignored events of one request: connections that skipped it because of a filter, a disabled connection or a transformation.Read-onlyList Request Ignored Events
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.
Inputs
idstringrequired- Request ID. Example: req_ZcR8m2Qp1aLs.
dirstring- Sort direction(s). One of: asc, desc. Example: asc.one of
ascdesc 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_requests_listList requests (webhooks received by a source) filtered by status, rejection cause, source, verification, dates or a text search on body, headers or path.Read-onlyList Requests
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.
Inputs
bodystring- URL Encoded string of the JSON to match to the data body. Example: {"status":"paid"}
cli_events_countinteger- Filter by count of CLI events. Example: 0.
created_at_gtestring- Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
created_at_ltestring- Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
dirstring- Sort direction. One of: asc, desc. Example: asc.one of
ascdesc events_countinteger- Filter by count of events. Example: 1.
headersstring- URL Encoded string of the JSON to match to the data headers. Example: {"x-shopify-topic":"orders/create"}
idstring- Filter by requests IDs. Example: web_UfM8Bmr4zxlW.
ignored_countinteger- Filter by count of ignored events. Example: 0.
includestring- 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_gtestring- Only include results whose ingested at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
ingested_at_ltestring- Only include results whose ingested at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
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. One of: created_at, ingested_at. Example: created_at.one of
created_atingested_at parsed_querystring- URL Encoded string of the JSON to match to the parsed query (JSON representation of the query). Example: {"page":"1"}
pathstring- URL Encoded string of the value to match partially to the path. Example: /webhooks/orders.
prevstring- The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
rejection_causestring- 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_DISABLEDNO_CONNECTIONVERIFICATION_FAILEDUNSUPPORTED_HTTP_METHODUNSUPPORTED_CONTENT_TYPEUNPARSABLE_JSONPAYLOAD_TOO_LARGEINGESTION_FATALUNKNOWN search_termstring- URL Encoded string of the value to match partially to the body, headers, parsed_query or path. Example: order_id.
source_idstring- Filter by source IDs. Example: src_yt8RaJNLxNEP.
statusstring- Filter by status. One of: accepted, rejected. Example: accepted.one of
acceptedrejected verifiedboolean- Filter by verification status. Example: true.
hookdeck_source_getGet one source by ID.Read-onlyGet Source
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.
Inputs
idstringrequired- Source ID. Example: src_yt8RaJNLxNEP.
includestring- include. One of: config.auth. Example: config.auth.one of
config.auth
hookdeck_sources_listList sources (the endpoints that receive webhooks) in the project, filtered by ID, name or disabled state.Read-onlyList Sources
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.
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 source IDs. Example: web_UfM8Bmr4zxlW.
limitinteger- Result set size. Example: 25.
namestring- The source name. Example: shopify.
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 source type. Example: WEBHOOK.
hookdeck_transformation_executions_listList executions of a transformation, filtered by log level, connection, issue or date.Read-onlyList Transformation Executions
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.
Inputs
idstringrequired- Transformation ID. Example: trs_m9Jf3dK7pQ2a.
created_at_gtestring- Only include results whose created at is on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
created_at_ltestring- Only include results whose created at is on or before this ISO 8601 date-time. Example: 2026-01-31T23:59:59Z.
dirstring- Sort direction(s). One of: asc, desc. Example: asc.one of
ascdesc issue_idstring- ID of the associated issue. Example: iss_Qn4Lp8sT2w1x.
limitinteger- Result set size. Example: 25.
log_levelstring- Log level of the execution. One of: debug, info, warn, error, fatal. Example: error.one of
debuginfowarnerrorfatal 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- ID of the connection the execution was run for. Example: web_UfM8Bmr4zxlW.
hookdeck_transformation_getGet one transformation by ID.Read-onlyGet Transformation
Get one transformation by ID. Returns the transformation with its code and environment variables. Use this to read the code.
Inputs
idstringrequired- Transformation ID. Example: trs_m9Jf3dK7pQ2a.
hookdeck_transformation_testRun transformation code (or a saved transformation) against a sample request without saving anything.Read-onlyTest Transformation
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.
Inputs
codestring- JavaScript code to be executed. Example: addHandler('transform', (request, context) => { request.headers['x-env'] = 'test'; return request; });.
envobject- Key-value environment variables to be passed to the transformation. Example: {"API_ENV":"test"}
event_data_idstring- 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.
requestobject- Request input to use for the transformation execution. Example: {"headers":{"content-type":"application/json"},"body":{"status":"paid"}}
transformation_idstring- Transformation ID. Example: trs_m9Jf3dK7pQ2a.
webhook_idstring- ID of the connection (webhook) to use for the execution context. Example: web_UfM8Bmr4zxlW.
hookdeck_transformations_listList transformations (JavaScript that rewrites requests before delivery).Read-onlyList Transformations
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.
Inputs
dirstring- Sort direction. One of: asc, desc. Example: asc.one of
ascdesc idstring- Filter by transformation IDs. Example: web_UfM8Bmr4zxlW.
limitinteger- Result set size. Example: 25.
namestring- Filter by transformation name. Example: sk-test-add-header.
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: created_at.one of
namecreated_atupdated_at prevstring- The ID to provide in the query to get the previous set of results. Example: evt_3fWxkUC9jw0aRS.
hookdeck_bookmark_createBookmark a request's payload (by event_data_id) for a connection so it can be replayed later.WriteCreate Bookmark
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.
Inputs
event_data_idstringrequired- ID of the event data to bookmark. Example: edt_0c7b5BkAn3kq.
labelstringrequired- Descriptive name of the bookmark. Example: sk-test failed order webhook.
webhook_idstringrequired- ID of the associated connection (webhook). Example: web_UfM8Bmr4zxlW.
namestring- A unique, human-friendly name for the bookmark. Example: sk-test-orders.
hookdeck_bookmark_triggerReplay a bookmarked payload through its connection, creating and delivering new events.WriteTrigger Bookmark
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.
Inputs
idstringrequired- Bookmark ID. Example: bmk_2Xc8Lm4pQ9sT.
hookdeck_connection_createCreate 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.WriteCreate Connection
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.
Inputs
descriptionstring- Description for the connection. Example: Order webhooks from Shopify.
destinationobject- Destination input object. Example: {"name":"sk-test-api","type":"HTTP","config":{"url":"https://example.com/webhooks"}}
destination_idstring- ID of a destination to bind to the connection. Example: des_8KgLp1vAEz7H.
namestring- A unique name of the connection for the source. Example: sk-test-orders.
rulesarray- Rules to apply to the connection. Filter, transform and deduplicate rules run in array order. Example: [{"type":"retry","strategy":"exponential","count":5,"interval":60000}]
sourceobject- Source input object. Example: {"name":"sk-test-shopify","type":"WEBHOOK"}
source_idstring- ID of a source to bind to the connection. Example: src_yt8RaJNLxNEP.
hookdeck_connection_disableDisable a connection: new events for it are not created.WriteDisable Connection
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.
- Idempotent
Inputs
idstringrequired- Connection ID. Example: web_UfM8Bmr4zxlW.
hookdeck_connection_enableEnable a disabled connection.WriteEnable Connection
Enable a disabled connection. Returns the connection with disabled_at cleared. Use this after hookdeck_connection_disable.
- Idempotent
Inputs
idstringrequired- Connection ID. Example: web_UfM8Bmr4zxlW.
hookdeck_connection_pausePause a connection: Hookdeck keeps accepting events but holds them until the connection is unpaused.WritePause Connection
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.
- Idempotent
Inputs
idstringrequired- Connection ID. Example: web_UfM8Bmr4zxlW.
hookdeck_connection_unpauseUnpause a connection so held events are delivered.WriteUnpause Connection
Unpause a connection so held events are delivered. Returns the connection with paused_at cleared. Use this after hookdeck_connection_pause.
- Idempotent
Inputs
idstringrequired- Connection ID. Example: web_UfM8Bmr4zxlW.
hookdeck_connection_updateUpdate a connection's name, description or rules.WriteUpdate Connection
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.
- Idempotent
Inputs
idstringrequired- Connection ID. Example: web_UfM8Bmr4zxlW.
descriptionstring- Description for the connection. Example: Order webhooks from Shopify.
namestring- name. Example: sk-test-orders.
rulesarray- Rules to apply to the connection. Filter, transform and deduplicate rules run in array order. Example: [{"type":"retry","strategy":"exponential","count":5,"interval":60000}]
hookdeck_destination_createCreate a destination: an HTTP endpoint, the Hookdeck CLI, a mock API or an SQS queue, with optional rate limit and auth config.WriteCreate Destination
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.
Inputs
namestringrequired- Name for the destination. Example: sk-test-orders.
configobject- The type configs for the specified type. Example: {"url":"https://example.com/webhooks"}
descriptionstring- Description for the destination. Example: Order webhooks from Shopify.
typestring- Type of the destination. One of: HTTP, CLI, MOCK_API, SQS. Example: HTTP.one of
HTTPCLIMOCK_APISQS
hookdeck_destination_disableDisable a destination so no events are delivered to it.WriteDisable Destination
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.
- Idempotent
Inputs
idstringrequired- Destination ID. Example: des_8KgLp1vAEz7H.
hookdeck_destination_enableEnable a disabled destination.WriteEnable Destination
Enable a disabled destination. Returns the destination with disabled_at cleared. Use this after hookdeck_destination_disable.
- Idempotent
Inputs
idstringrequired- Destination ID. Example: des_8KgLp1vAEz7H.
hookdeck_destination_updateUpdate a destination's name, type, description or config.WriteUpdate Destination
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.
- Idempotent
Inputs
idstringrequired- Destination ID. Example: des_8KgLp1vAEz7H.
configobject- The type configs for the specified type. Example: {"url":"https://example.com/webhooks"}
descriptionstring- Description for the destination. Example: Order webhooks from Shopify.
namestring- Name for the destination. Example: sk-test-orders.
typestring- Type of the destination. One of: HTTP, CLI, MOCK_API, SQS. Example: HTTP.one of
HTTPCLIMOCK_APISQS
hookdeck_event_cancelCancel all future automatic retries of an event.WriteCancel Event
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.
- Idempotent
Inputs
idstringrequired- Event ID. Example: evt_3fWxkUC9jw0aRS.
hookdeck_event_muteMute an event: cancel its scheduled retries and stop it from counting toward issues.WriteMute Event
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.
- Idempotent
Inputs
idstringrequired- Event ID. Example: evt_3fWxkUC9jw0aRS.
hookdeck_event_retryRetry delivery of one event now.WriteRetry Event
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.
Inputs
idstringrequired- Event ID. Example: evt_3fWxkUC9jw0aRS.
hookdeck_events_bulk_retry_createStart a bulk retry of every event matching a query (the same filters as hookdeck_events_list, e.g.WriteBulk Retry Events
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.
Inputs
queryobject- Filter properties for the events to be included in the bulk retry. Example: {"status":"FAILED","webhook_id":"web_UfM8Bmr4zxlW"}
hookdeck_issue_trigger_createCreate an issue trigger for delivery, transformation, backpressure or request issues and choose its notification channels.WriteCreate Issue Trigger
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.
Inputs
channelsobjectrequired- Notification channels object for the specific channel type. Example: {"email":{}}
typestringrequired- Issue type. Example: delivery.
configsobject- Configuration object for the specific issue type selected. Example: {"strategy":"first_attempt","connections":"*"}
namestring- Optional unique name to use as reference when using the API. Example: sk-test-delivery-alerts.
hookdeck_issue_trigger_updateUpdate an issue trigger's name, configs or channels.WriteUpdate Issue Trigger
Update an issue trigger's name, configs or channels. Returns the updated trigger. Use this to change alert conditions or recipients.
- Idempotent
Inputs
idstringrequired- Issue trigger ID. Example: it_BXBPmXR5tE1V.
channelsobject- Notification channels object for the specific channel type. Example: {"email":{}}
configsobject- Configuration object for the specific issue type selected. Example: {"strategy":"first_attempt","connections":"*"}
disabled_atstring- Date when the issue trigger was disabled. Example: 2026-01-01T00:00:00Z.
namestring- Optional unique name to use as reference when using the API. Example: sk-test-delivery-alerts.
hookdeck_issue_updateSet an issue's status to OPENED, ACKNOWLEDGED, RESOLVED or IGNORED.WriteUpdate Issue Status
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.
- Idempotent
Inputs
idstringrequired- Issue ID. Example: iss_Qn4Lp8sT2w1x.
statusstringrequired- New status. One of: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED. Example: ACKNOWLEDGED.one of
OPENEDIGNOREDACKNOWLEDGEDRESOLVED
hookdeck_request_retryRe-process a received request through the current connections and rules, creating new events for the given connections.WriteRetry Request
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.
Inputs
idstringrequired- Request ID. Example: req_ZcR8m2Qp1aLs.
webhook_idsarray- 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"]
hookdeck_source_createCreate 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.WriteCreate Source
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.
Inputs
namestringrequired- A unique name for the source. Example: sk-test-orders.
configobject- The type configs for the specified type. Example: {"allowed_http_methods":["POST"]}
descriptionstring- Description for the source. Example: Order webhooks from Shopify.
typestring- 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.
hookdeck_source_disableDisable a source so it rejects incoming requests.WriteDisable Source
Disable a source so it rejects incoming requests. Returns the source with disabled_at set. Use hookdeck_source_enable to turn it back on.
- Idempotent
Inputs
idstringrequired- Source ID. Example: src_yt8RaJNLxNEP.
hookdeck_source_enableEnable a disabled source.WriteEnable Source
Enable a disabled source. Returns the source with disabled_at cleared. Use this after hookdeck_source_disable.
- Idempotent
Inputs
idstringrequired- Source ID. Example: src_yt8RaJNLxNEP.
hookdeck_source_updateUpdate a source's name, type, description or config.WriteUpdate Source
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.
- Idempotent
Inputs
idstringrequired- Source ID. Example: src_yt8RaJNLxNEP.
configobject- The type configs for the specified type. Example: {"allowed_http_methods":["POST"]}
descriptionstring- Description for the source. Example: Order webhooks from Shopify.
namestring- A unique name for the source. Example: sk-test-orders.
typestring- Source type: WEBHOOK, HTTP or a provider name in upper case such as STRIPE, SHOPIFY, GITHUB or TWILIO. Example: WEBHOOK.
hookdeck_transformation_createCreate a transformation from JavaScript code that calls addHandler('transform', ...), with optional environment variables.WriteCreate Transformation
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.
Inputs
codestringrequired- JavaScript code to be executed as string. Example: addHandler('transform', (request, context) => { request.headers['x-env'] = 'test'; return request; });.
namestringrequired- A unique, human-friendly name for the transformation. Example: sk-test-add-header.
envobject- Key-value environment variables to be passed to the transformation. Example: {"API_ENV":"test"}
hookdeck_transformation_updateUpdate a transformation's name, code or environment variables.WriteUpdate Transformation
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.
- Idempotent
Inputs
idstringrequired- Transformation ID. Example: trs_m9Jf3dK7pQ2a.
codestring- JavaScript code to be executed. Example: addHandler('transform', (request, context) => { request.headers['x-env'] = 'test'; return request; });.
envobject- Key-value environment variables to be passed to the transformation. Example: {"API_ENV":"test"}
namestring- A unique, human-friendly name for the transformation. Example: sk-test-add-header.
hookdeck_bookmark_deleteDelete a bookmark.DestructiveDelete Bookmark
Delete a bookmark. Returns the deleted bookmark's ID. Use this to remove a saved payload.
- Idempotent
Inputs
idstringrequired- Bookmark ID. Example: bmk_2Xc8Lm4pQ9sT.
hookdeck_connection_deletePermanently delete a connection.DestructiveDelete Connection
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.
- Idempotent
Inputs
idstringrequired- id. Example: web_UfM8Bmr4zxlW.
hookdeck_destination_deletePermanently delete a destination.DestructiveDelete Destination
Permanently delete a destination. Returns the deleted destination's ID. Use hookdeck_destination_disable to stop deliveries but keep it.
- Idempotent
Inputs
idstringrequired- id. Example: des_8KgLp1vAEz7H.
hookdeck_issue_dismissDismiss an issue.DestructiveDismiss Issue
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.
- Idempotent
Inputs
idstringrequired- Issue ID. Example: iss_Qn4Lp8sT2w1x.
hookdeck_issue_trigger_deleteDelete an issue trigger.DestructiveDelete Issue Trigger
Delete an issue trigger. Returns the deleted trigger's ID. Use this to remove an alert rule.
- Idempotent
Inputs
idstringrequired- Issue trigger ID. Example: it_BXBPmXR5tE1V.
hookdeck_source_deletePermanently delete a source.DestructiveDelete Source
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.
- Idempotent
Inputs
idstringrequired- id. Example: src_yt8RaJNLxNEP.
hookdeck_transformation_deleteDelete a transformation.DestructiveDelete Transformation
Delete a transformation. Returns the deleted transformation's ID. Use this to remove unused code.
- Idempotent
Inputs
idstringrequired- Transformation ID. Example: trs_m9Jf3dK7pQ2a.
No tools match.