Skip to main content
Hookdeck logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 105
  • Triggers: 0
  • Slug: HOOKDECK
  • Version: 20261101_00

Tools

Slug: HOOKDECK_ADD_CUSTOM_DOMAINTool to add a custom domain to the Hookdeck project. Use when you need to configure a custom hostname for receiving webhooks.

Input Parameters

string
required
The custom hostname to attach to the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_BULK_CANCEL_EVENTSTool to create a bulk cancellation job for events. Use when you need to cancel multiple events matching filters.

Input Parameters

object
required
Filter object specifying conditions for selecting events to cancel. At least one filter property should be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_BULK_RETRY_EVENTSInitiate a bulk retry for multiple events matching the specified filters. Use this to retry failed webhook deliveries in bulk instead of one at a time. The query must include at least one filter - common usage is to filter by status=‘FAILED’. The operation runs asynchronously and returns immediately with progress tracking info.

Input Parameters

object
required
Filter object specifying conditions for selecting events to retry. Must include at least one filter (e.g., status=‘FAILED’ to retry all failed events).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CANCEL_EVENTCancel all future delivery attempts for a Hookdeck event. Use this to stop scheduled retries when you need to prevent further delivery attempts (e.g., due to known issues with the destination or invalid payload). Note: Events already in SUCCESSFUL or FAILED status cannot be cancelled but the API will return the event unchanged.

Input Parameters

string
required
The unique identifier of the Hookdeck event to cancel. Obtain this from HOOKDECK_GET_EVENTS or event notification webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CANCEL_EVENT_BULK_RETRYTool to cancel an ongoing events bulk retry operation. Use when you need to stop a bulk retry that is currently in progress (e.g., if you realize the retry conditions were incorrect or the issue needs to be addressed before retrying).

Input Parameters

string
required
The unique identifier of the bulk retry operation to cancel (e.g., ‘bch_DiPOKivhmufni7’). Obtain this from the BulkRetryEvents action response or bulk retry status endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CANCEL_REQUEST_BULK_RETRYTool to cancel an in-progress requests bulk retry operation. Use when you need to stop a bulk retry that is currently running.

Input Parameters

string
required
Bulk retry ID to cancel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CANCEL_SCHEDULED_RETRIESTool to cancel all future scheduled retries for an event. Use when you need to mute automatic retry attempts after repeated failures.

Input Parameters

string
required
The unique identifier of the event to cancel scheduled retries for. Use HOOKDECK_GET_EVENTS to retrieve event IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_COUNT_CONNECTIONSTool to count Hookdeck connections with optional filters. Use when you need to get the total number of connections matching specific criteria.

Input Parameters

boolean
Include disabled resources in the response
string
Date the connection was paused
string
Filter by associated source IDs
string
Date the connection was disabled
string
Filter by associated destination IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_COUNT_DESTINATIONSTool to count Hookdeck destinations with optional filters. Use when you need to get a total count of destinations without retrieving full details.

Input Parameters

string
Filter by destination IDs.
string
Filter by destination name.
boolean
Include disabled resources in the response if true.
string
Filter destinations disabled at a specific date or with operators (e.g., ‘<2023-02-01T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_COUNT_SOURCESTool to count Hookdeck sources with optional filters. Use when you need to get a total count of sources without retrieving full details.

Input Parameters

string
Filter by source IDs.
string
Filter by source name.
string
Filter by source type.
boolean
Include disabled resources in the response if true.
string
Filter sources disabled at a specific date or with operators (e.g., ‘<2023-02-01T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CREATE_BOOKMARKTool to create a bookmark for a specific event request in Hookdeck. Bookmarks allow you to catalog and replay specific webhook requests. Use this to save important or edge-case requests for testing, debugging, or documentation purposes. Bookmarked request data is exempt from the archiving period and remains available as long as it is bookmarked.

Input Parameters

string
required
Descriptive name for the bookmark shown in the Hookdeck UI and CLI.
string
required
ID of the associated connection (webhook) where the event originated. Obtain this from event objects or via HOOKDECK_GET_CONNECTIONS.
string
required
ID of the event data to bookmark. Obtain this from event objects via HOOKDECK_GET_EVENTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CREATE_CONNECTIONTool to create a connection between a source and a destination. Use after setting up or referencing source/destination.

Input Parameters

string
Optional unique name for the connection.
array
Optional list of rules for the connection (retry, filter, transform, delay, deduplicate).
object
Inline input for creating a source.
string
ID of an existing source to bind to this connection.
string
Optional human-readable description for the connection.
object
Inline input for creating a destination.
string
ID of an existing destination to bind to this connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CREATE_DESTINATIONTool to create a new Hookdeck destination. Use after setting up sources when you need to route events to endpoints.

Input Parameters

string
required
Unique destination name; letters, numbers, hyphens, or underscores only; max 155 chars.
string ("HTTP" | "CLI" | "MOCK_API")
Destination type; one of HTTP, CLI, or MOCK_API. Defaults to HTTP.
object
Configuration object for the destination; fields vary by destination type.
string
Human-readable description of the destination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CREATE_IGNORED_EVENT_BULK_RETRYTool to create an ignored events bulk retry operation. Use when you need to retry multiple ignored events matching specific filters. The query must include at least one filter parameter (webhook_id, cause, or transformation_id) - empty queries are not allowed.

Input Parameters

object
required
Filter object specifying conditions for selecting ignored events to retry. Must include at least one filter (webhook_id, cause, or transformation_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CREATE_INTEGRATIONTool to create a new Hookdeck integration. Use when you need to set up authentication or verification for webhook sources using providers like API keys, HMAC, Basic Auth, or third-party services.

Input Parameters

string
Label of the integration for easy identification.
object
Decrypted key/value object of the associated configuration for the provider. Required fields vary by provider (e.g., ‘api_key’ for API_KEY provider, ‘webhook_secret_key’ for HMAC, ‘username’ and ‘password’ for BASIC_AUTH).
array
List of features to enable for this integration.
string ("AIPRISE" | "DOCUSIGN" | "INTERCOM" | "HMAC" | "BASIC_AUTH" | "API_KEY" | "MANAGED" | "HOOKDECK_OUTPOST" | "SANITY" | "BIGCOMMERCE" | "OPENAI" | "POLAR" | "BRIDGE" | "CHARGEBEE_BILLING" | "CLOUDSIGNAL" | "COINBASE" | "COURIER" | "CURSOR" | "MERAKI" | "FIREBLOCKS" | "FRONTAPP" | "ZOOM" | "TWITTER" | "RECHARGE" | "RECURLY" | "RING_CENTRAL" | "STRIPE" | "PROPERTY-FINDER" | "QUOTER" | "SHOPIFY" | "TWILIO" | "GITHUB" | "POSTMARK" | "TALLY" | "TYPEFORM" | "PICQER" | "XERO" | "SVIX" | "RESEND" | "ADYEN" | "AKENEO" | "GITLAB" | "WOOCOMMERCE" | "OKTA" | "OURA" | "COMMERCELAYER" | "HUBSPOT" | "MAILGUN" | "PERSONA" | "PIPEDRIVE" | "SENDGRID" | "WORKOS" | "SYNCTERA" | "AWS_SNS" | "THREE_D_EYE" | "TWITCH" | "ENODE" | "FAVRO" | "LINEAR" | "SHOPLINE" | "WIX" | "NMI" | "ORB" | "PYLON" | "RAZORPAY" | "REPAY" | "SQUARE" | "SOLIDGATE" | "TRELLO" | "EBAY" | "TELNYX" | "DISCORD" | "TOKENIO" | "FISERV" | "FUSIONAUTH" | "BONDSMITH" | "VERCEL_LOG_DRAINS" | "VERCEL" | "TEBEX" | "SLACK" | "SMARTCAR" | "MAILCHIMP" | "NUVEMSHOP" | "PADDLE" | "PAYPAL" | "PORTAL" | "TREEZOR" | "PRAXIS" | "CUSTOMERIO" | "EXACT_ONLINE" | "FACEBOOK" | "WHATSAPP" | "REPLICATE" | "TIKTOK" | "TIKTOK_SHOP" | "AIRWALLEX" | "ASCEND" | "ALIPAY" | "ZENDESK" | "UPOLLO" | "SMILE" | "NYLAS" | "CLIO" | "GOCARDLESS" | "LINKEDIN" | "LITHIC" | "UTILA" | "ZEROHASH" | "AIRTABLE" | "ASANA" | "FASTSPRING" | "PAYPRO_GLOBAL" | "USPS" | "FLEXPORT")
Supported integration providers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CREATE_ISSUE_TRIGGERTool to create an issue trigger in Hookdeck. Use when you need to set up automated notifications for delivery failures, transformation errors, or backpressure events.

Input Parameters

string
Optional unique name to reference the issue trigger via API.
string ("delivery" | "transformation" | "backpressure")
required
Issue type: ‘delivery’, ‘transformation’, or ‘backpressure’.
object
Configuration object based on issue type. For delivery: {strategy: ‘first_attempt’, connections: ''}. For transformation: {log_level: ‘error’, transformations: ''}. For backpressure: {delay: 1000, destinations: ’*’}.
object
required
Notification channels configuration. At least one channel must be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CREATE_SOURCETool to create a new Hookdeck source. Use after setting up your project when you need to receive and route incoming webhooks.

Input Parameters

string
required
Unique source name; letters, numbers, hyphens, or underscores only; max 155 chars.
string ("WEBHOOK" | "PUBLISH_API" | "AIPRISE" | "DOCUSIGN" | "INTERCOM")
Predefined source type. Omit for a generic webhook source.
object
Configuration object for the source; fields vary by source type.
string
Human-readable description of the source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_CREATE_TRANSFORMATIONTool to create a new Hookdeck transformation. Use when you need to execute custom JavaScript to modify event payloads before delivery.

Input Parameters

object
Key-value environment variables to pass to the transformation.
string
required
JavaScript code to execute for the transformation. Must use the addHandler syntax with ‘transform’ as the handler type. The handler receives (request, context) parameters where request contains headers, body, query, parsed_query, and path.
string
required
Unique transformation name; letters, numbers, hyphens, or underscores only; max 155 chars.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DELETE_BOOKMARKTool to delete a specific bookmark by its ID. Use when you need to permanently remove a bookmark after confirming it’s no longer needed.

Input Parameters

string
required
The unique identifier of the bookmark to permanently delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DELETE_CONNECTIONTool to delete a specific connection by its ID. Use when you need to permanently remove a connection after confirming it’s no longer needed.

Input Parameters

string
required
The unique identifier of the connection to permanently delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DELETE_DESTINATIONPermanently deletes a Hookdeck destination by its ID, along with all connections that rely on it; associated event data is retained for the remainder of the retention window. A 404 response is reported as an error.

Input Parameters

string
required
The unique identifier of the destination to delete. Format: des_XXXXXXXXXXXX (e.g., des_abc123xyz456). Obtain this ID from HOOKDECK_GET_DESTINATIONS or HOOKDECK_CREATE_DESTINATION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DELETE_INTEGRATIONTool to delete a specific integration by its ID. Use when you need to permanently remove an integration after confirming it’s no longer needed.

Input Parameters

string
required
The unique identifier of the integration to permanently delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DELETE_ISSUE_TRIGGERTool to delete a specific issue trigger by its ID. Use when you need to permanently remove an issue trigger after confirming it’s no longer needed.

Input Parameters

string
required
The unique identifier of the issue trigger to permanently delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DELETE_SOURCETool to delete a specific source by its ID. Use when you need to permanently remove a source after confirming it’s no longer needed.

Input Parameters

string
required
The unique identifier of the source to permanently delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DELETE_TRANSFORMATIONPermanently delete a Hookdeck transformation by its ID. The transformation must not be in use by any connections before deletion. Returns the ID of the deleted transformation on success. Use this when you need to clean up unused transformations from your Hookdeck workspace.

Input Parameters

string
required
The unique identifier of the transformation to permanently delete. Transformation IDs start with ‘trs_’ prefix. Note: A transformation can only be deleted if it is not being used by any connections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DISABLE_CONNECTIONTool to disable a connection by its ID. Use when you need to temporarily stop event delivery through a connection without deleting it.

Input Parameters

string
required
The unique identifier of the connection to disable

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DISABLE_DESTINATIONTool to disable a Hookdeck destination. Use when you need to temporarily stop event delivery to a destination without deleting it. Disabled destinations can be re-enabled later.

Input Parameters

string
required
The unique identifier of the destination to disable. Format: des_XXXXXXXXXXXX (e.g., des_wBqey0VM3ige). Obtain this ID from HOOKDECK_GET_DESTINATIONS or HOOKDECK_CREATE_DESTINATION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DISABLE_ISSUE_TRIGGERTool to disable a Hookdeck issue trigger. Use when you need to temporarily stop notifications for a specific issue trigger without deleting it. The trigger can be re-enabled later if needed.

Input Parameters

string
required
Issue trigger ID to disable. Obtain this from list issue triggers or retrieve issue trigger endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_DISABLE_SOURCETool to disable a Hookdeck source. Use when you need to stop a source from accepting new webhook events without deleting it.

Input Parameters

string
required
The unique identifier of the source to disable (e.g., ‘src_1234567890abcdef’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_ENABLE_CONNECTIONTool to enable a disabled Hookdeck connection. Use when you need to reactivate a previously disabled connection to resume event routing.

Input Parameters

string
required
The unique ID of the connection to enable (e.g., ‘web_EnFSYBHW1nX1’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_ENABLE_DESTINATIONEnable a previously disabled Hookdeck destination by its ID. This allows events to be delivered to the destination again.

Input Parameters

string
required
The unique identifier of the destination to enable. Format: des_XXXXXXXXXXXX (e.g., des_wBqey0VM3ige). Obtain this ID from HOOKDECK_GET_DESTINATIONS or HOOKDECK_CREATE_DESTINATION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_ENABLE_ISSUE_TRIGGERTool to enable a Hookdeck issue trigger. Use when you need to activate an issue trigger that was previously disabled.

Input Parameters

string
required
The unique identifier of the issue trigger to enable

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_ENABLE_SOURCETool to enable a disabled Hookdeck source. Use when you need to reactivate a source that was previously disabled.

Input Parameters

string
required
The unique identifier of the source to enable (e.g., ‘src_t724yotizx9dkm’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GENERATE_EVENT_BULK_CANCEL_PLANTool to generate a preview plan for bulk event cancellation. Use when you need to estimate how many events would be cancelled by a query before executing the actual bulk cancel operation.

Input Parameters

object
required
Filter object specifying conditions for selecting events to preview cancellation. At least one filter property must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GENERATE_EVENT_BULK_RETRY_PLANTool to generate an events bulk retry plan. Use when you need to estimate the scope of a bulk retry operation before executing it. Returns the estimated number of events that would be retried and the number of batches required.

Input Parameters

object
required
Filter object specifying conditions for selecting events to include in the retry plan. Must include at least one filter (e.g., status=‘FAILED’ to plan retry for all failed events).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GENERATE_IGNORED_EVENT_BULK_RETRY_PLANGenerate an ignored events bulk retry plan to estimate the scope before execution. Use this to preview how many events would be retried and how many batches are needed. This action does not execute the retry - it only provides estimates for planning purposes.

Input Parameters

object
required
Filter object specifying which ignored events to include in the retry plan. Must include at least one filter (webhook_id, cause, or transformation_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GENERATE_REQUEST_BULK_RETRY_PLANTool to generate a requests bulk retry plan. Use when you need to estimate the number of requests and batches for a bulk retry operation before executing it. Accepts the same query filters as the List Requests endpoint.

Input Parameters

object
Filter properties for the requests to be included in the bulk retry plan. Supports the same query parameters as the List Requests endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_ATTEMPT2Tool to retrieve a specific Hookdeck delivery attempt by ID. Use when you have an attempt ID and need delivery details including status, response codes, timing, and errors.

Input Parameters

string
required
The unique identifier of the Hookdeck attempt to retrieve (e.g., ‘atm_dNDcsLgseeRpa4zUuuRS’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_ATTEMPTSLists delivery attempts for your Hookdeck account. Attempts represent individual HTTP delivery tries to destination URLs. Use this to monitor delivery status, debug failures, and track retry attempts. Filter by event_id to see all attempts for a specific event. Only attempts with status SUCCESSFUL or FAILED are returned.

Input Parameters

string
Filter by one or more attempt IDs (e.g., ‘atm_xxx’).
string
Sort direction: ‘asc’ for ascending or ‘desc’ for descending. Defaults to ‘desc’.
string
Cursor token from a previous response to fetch the next page of results.
string
Cursor token from a previous response to fetch the previous page of results.
integer
Maximum number of attempts to return per page (1-250). Defaults to 100.
string
Filter by one or more event IDs to get attempts for specific events.
string
Field to sort results by. Defaults to ‘created_at’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_ATTEMPTS_METRICSTool to query aggregated attempt metrics with time-based grouping and filtering. Use when you need to analyze delivery attempt patterns over time, calculate statistics like attempt counts, or group metrics by dimensions such as status or destination.

Input Parameters

object
Additional filters to apply to the metrics query
array
required
Metrics to calculate (e.g., ‘count’)
object
required
Date range with start and end timestamps in ISO 8601 format
array
Dimensions to group metrics by
string
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’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_BOOKMARKTool to retrieve a single bookmark by its ID. Use when you need to fetch details of a specific bookmark.

Input Parameters

string
required
The unique identifier of the bookmark to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_BOOKMARK_RAW_BODYTool to retrieve the raw body data of a bookmarked request. Use when you need to access the original unmodified request body payload that was bookmarked in Hookdeck.

Input Parameters

string
required
The unique identifier of the bookmark to retrieve raw body data for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_CONNECTIONRetrieves details of a specific Hookdeck connection by its ID. Returns the connection configuration including its source, destination, and any configured rules. Use this to inspect connection settings, verify configuration, or get source/destination details.

Input Parameters

string
required
The unique ID of the connection to retrieve (starts with ‘web_‘)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_CONNECTIONSTool to list Hookdeck connections. Use when you need to retrieve or filter your configured connections. Each connection in the response embeds full source and destination objects; reuse these nested objects directly instead of making additional fetch calls.

Input Parameters

string
Filter by one or more connection IDs.
string ("asc" | "desc")
Sort direction: asc or desc. Default: desc.
string
Cursor for next page of results. Value comes from the response body of the previous call.
string
Cursor for previous page of results. Value comes from the response body of the previous call.
integer
Page size: integer between 1 and 250. Defaults to 100.
boolean
Include disabled connections if true.
string
Sort key(s). Default: created_at.
string
Fuzzy match on combined ‘source -> connection’ name.
object
Filter by paused date using operators (gte, gt, lte, lt).
string
Filter by one or more source IDs.
object
Filter by disabled date using operators (gte, gt, lte, lt).
string
Filter by one or more destination IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_DESTINATIONRetrieve details of a specific Hookdeck destination by ID. Use this tool to get the full configuration and status of a destination, including its URL, authentication settings, rate limits, and timestamps.

Input Parameters

string
required
Unique identifier of the destination to retrieve (e.g., ‘des_xxxxx’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_DESTINATIONSTool to list Hookdeck destinations. Use when you need to retrieve or filter your configured destinations.

Input Parameters

string
Filter by one or more destination IDs.
string ("asc" | "desc")
Sort direction: asc or desc. Defaults to desc.
string
Filter by one or more destination names.
string
Cursor for next page. Extract from previous response’s pagination metadata and pass here to advance pages.
string
Cursor for previous page.
string
Filter by destination type. Allowed values: HTTP, CLI, MOCK_API.
integer
Page size: integer between 1 and 255. Defaults to 100.
boolean
Include disabled destinations if true.
string ("name" | "created_at" | "updated_at")
Sort key: name, created_at, or updated_at. Defaults to created_at.
string
Filter destinations disabled at a specific timestamp or with operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENTTool to retrieve a specific Hookdeck event by ID. Use when you need detailed information about an event including status, delivery attempts, and payload data.

Input Parameters

string
required
ID of the Hookdeck event to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENT_BULK_CANCELTool to retrieve the status of a bulk event cancellation operation. Use when you need to check the progress or completion status of a bulk cancel job. The bulk cancel ID is returned when initiating a bulk cancel operation.

Input Parameters

string
required
Bulk cancel ID to retrieve (e.g., ‘bch_8wrFV34ahWBqGa’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENT_BULK_CANCELSTool to list event bulk cancel operations for your Hookdeck account. Use when you need to retrieve bulk cancel operation logs, filter by status or time, and paginate through results.

Input Parameters

string
Filter by one or more bulk cancel IDs.
string
Sort direction (asc or desc).
string
The ID to provide in the query to get the next set of results.
string
The ID to provide in the query to get the previous set of results.
integer
Result set size.
object
Filter for events to be included in the bulk cancel operation, use query parameters of Event.
string
Sort key for results.
string
Filter by date the bulk cancel was created. Accepts ISO-8601 string or operators dict like {‘gte’: ‘2023-01-01T00:00:00Z’}.
boolean
Indicates if the bulk cancel is currently in progress.
string
Filter by date the bulk cancel was cancelled. Accepts ISO-8601 string or operators dict like {‘gte’: ‘2023-01-01T00:00:00Z’}.
string
Filter by date the bulk cancel completed. Accepts ISO-8601 string or operators dict like {‘gte’: ‘2023-01-01T00:00:00Z’}.
boolean
Allow partial filter match on query property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENT_BULK_RETRIESTool to retrieve bulk retry operations for Hookdeck events. Use when you need to check the status of bulk retry jobs, monitor their progress, or list historical bulk retry operations.

Input Parameters

string
Filter by one or more bulk retry IDs.
string
Sort direction for results: ‘asc’ for ascending or ‘desc’ for descending.
string
Cursor token to fetch the next page of results. Provided in pagination object of previous response.
string
Cursor token to fetch the previous page of results. Provided in pagination object of previous response.
integer
Maximum number of results to return per page.
object
Filter for events to be included in the bulk retry, using query parameters of Event filters (e.g., status, webhook_id, source_id).
string
Sort key for results. Common values: ‘created_at’, ‘updated_at’.
string
Filter by date the bulk retry was created. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
boolean
Filter by whether the bulk retry is currently in progress. True for running operations, false for completed or cancelled.
string
Filter by date the bulk retry was cancelled. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
string
Filter by date the bulk retry completed. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
boolean
Allow partial filter match on query property. When true, relaxes exact matching requirements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENT_BULK_RETRYTool to retrieve the status of a bulk event retry operation. Use when you need to check the progress or completion status of a bulk retry job. The bulk retry ID is returned when initiating a bulk retry operation.

Input Parameters

string
required
Bulk retry ID to retrieve (e.g., ‘bch_DiPOKivhmufni7’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENT_RAW_BODYTool to retrieve the raw body data of an event. Use when you need to access the original unmodified request body payload of a Hookdeck event.

Input Parameters

string
required
Event ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENTSTool to list events for your Hookdeck account. Use when you need to retrieve delivery logs, filter by status or time, and paginate through results.

Input Parameters

string
Filter by one or more event IDs.
string ("asc" | "desc")
Sort direction: asc or desc; default is ‘desc’.
string
Cursor to fetch the next page.
string
Cursor to fetch the previous page.
integer
Page size; default 100; max 250.
string
Filter by event lifecycle status (e.g., SUCCESSFUL, QUEUED, FAILED).
object
Filter by number of delivery attempts with operators. E.g., {‘gte’: 2, ‘lte’: 5}.
string
Sort key; default is ‘created_at’.
string
Filter by one or more source IDs.
object
Filter by event creation timestamp with operators. E.g., {‘gte’: ‘2023-01-01T00:00:00Z’}.
string
Filter by one or more connection (webhook) IDs.
string
Filter by one or more destination IDs.
string
Filter by HTTP response status code(s) or with operators. E.g., 200, [200,404], or {‘gte’:400}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENTS_BY_ISSUE_METRICSTool to query event metrics grouped by individual issue IDs. Uses arrayJoin to create one row per issue per event, enabling per-issue analytics. Use when tracking which issues affect the most events over time.

Input Parameters

object
required
Filters object with required issue_id field
array
required
Array of metrics to calculate (e.g., ‘count’)
object
required
Date range with start and end timestamps in ISO 8601 format
array
Array of dimension names to group by
string
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENTS_METRICSTool to query aggregated event metrics with time-based grouping and filtering. Use when you need to analyze event patterns, calculate statistics, or generate reports over specific time periods.

Input Parameters

object
Filter criteria for the metrics query
array
required
Array of metric names to calculate (e.g., [‘count’, ‘success_rate’])
object
required
Date range object with ‘start’ and ‘end’ fields in ISO 8601 format
array
Dimensions to group by (e.g., [‘source_id’, ‘destination_id’])
string
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_EVENTS_PENDING_TIMESERIES_METRICSTool to query aggregated events pending timeseries metrics with time-based grouping and filtering. Use when you need to analyze pending event trends over time, monitor event backlogs, or generate time-series reports with custom granularity. Supports grouping by dimensions like source or destination.

Input Parameters

object
Optional filters to apply to the metrics query.
array
required
List of measures to aggregate (e.g., ‘count’). At least one measure is required.
object
required
Date range with start and end timestamps for the metrics query.
array
List of dimensions to group results by (e.g., source_id, destination_id).
string
Time bucket granularity for grouping metrics. 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’, ‘1w’, ‘1M’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_IGNORED_EVENT_BULK_RETRIESTool to retrieve ignored events bulk retry operations for Hookdeck. Use when you need to check the status of ignored events bulk retry jobs, monitor their progress, or list historical ignored events bulk retry operations.

Input Parameters

string
Filter by one or more bulk retry IDs.
string
Sort direction for results: ‘asc’ for ascending or ‘desc’ for descending.
string
Cursor token to fetch the next page of results. Provided in pagination object of previous response.
string
Cursor token to fetch the previous page of results. Provided in pagination object of previous response.
integer
Maximum number of results to return per page.
object
Filter by the bulk retry ignored event query object. This object specifies conditions for selecting ignored events (e.g., webhook_id, cause, transformation_id).
string
Sort key for results. Common values: ‘created_at’, ‘updated_at’.
string
Filter by date the bulk retry was created. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
boolean
Filter by whether the bulk retry is currently in progress. True for running operations, false for completed or cancelled.
string
Filter by date the bulk retry was cancelled. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
string
Filter by date the bulk retry completed. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
boolean
Allow partial filter match on query property. When true, relaxes exact matching requirements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_IGNORED_EVENT_BULK_RETRYTool to retrieve the status of an ignored events bulk retry operation. Use when you need to check the progress or completion status of a bulk retry job for ignored events.

Input Parameters

string
required
Bulk retry ID to retrieve (e.g., ‘bch_FSTzBqxJLCpTF4’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_INTEGRATIONTool to retrieve details of a specific Hookdeck integration. Use when you need to inspect integration configuration, verify credentials, or check which sources are using the integration.

Input Parameters

string
required
Integration ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_INTEGRATIONSTool to retrieve a list of Hookdeck integrations. Use when you need to list all integrations or filter them by label or provider.

Input Parameters

string
Cursor to fetch the next page of results.
string
Cursor to fetch the previous page of results.
string
Filter integrations by label.
integer
Maximum number of integrations to return per page (1-250).
string ("AIPRISE" | "DOCUSIGN" | "INTERCOM" | "HMAC" | "BASIC_AUTH" | "API_KEY" | "MANAGED" | "HOOKDECK_OUTPOST" | "SANITY" | "BIGCOMMERCE" | "OPENAI" | "POLAR" | "BRIDGE" | "CHARGEBEE_BILLING" | "CLOUDSIGNAL" | "COINBASE" | "COURIER" | "CURSOR" | "MERAKI" | "FIREBLOCKS" | "FRONTAPP" | "ZOOM" | "TWITTER" | "RECHARGE" | "RECURLY" | "RING_CENTRAL" | "STRIPE" | "PROPERTY-FINDER" | "QUOTER" | "SHOPIFY" | "TWILIO" | "GITHUB" | "POSTMARK" | "TALLY" | "TYPEFORM" | "PICQER" | "XERO" | "SVIX" | "RESEND" | "ADYEN" | "AKENEO" | "GITLAB" | "WOOCOMMERCE" | "OKTA" | "OURA" | "COMMERCELAYER" | "HUBSPOT" | "MAILGUN" | "PERSONA" | "PIPEDRIVE" | "SENDGRID" | "WORKOS" | "SYNCTERA" | "AWS_SNS" | "THREE_D_EYE" | "TWITCH" | "ENODE" | "FAVRO" | "LINEAR" | "SHOPLINE" | "WIX" | "NMI" | "ORB" | "PYLON" | "RAZORPAY" | "REPAY" | "SQUARE" | "SOLIDGATE" | "TRELLO" | "EBAY" | "TELNYX" | "DISCORD" | "TOKENIO" | "FISERV" | "FUSIONAUTH" | "BONDSMITH" | "VERCEL_LOG_DRAINS" | "VERCEL" | "TEBEX" | "SLACK" | "SMARTCAR" | "MAILCHIMP" | "NUVEMSHOP" | "PADDLE" | "PAYPAL" | "PORTAL" | "TREEZOR" | "PRAXIS" | "CUSTOMERIO" | "EXACT_ONLINE" | "FACEBOOK" | "WHATSAPP" | "REPLICATE" | "TIKTOK" | "TIKTOK_SHOP" | "AIRWALLEX" | "ASCEND" | "ALIPAY" | "ZENDESK" | "UPOLLO" | "SMILE" | "NYLAS" | "CLIO" | "GOCARDLESS" | "LINKEDIN" | "LITHIC" | "UTILA" | "ZEROHASH" | "AIRTABLE" | "ASANA" | "FASTSPRING" | "PAYPRO_GLOBAL" | "USPS" | "FLEXPORT")
Supported integration providers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_ISSUE_COUNTTool to get the count of Hookdeck issues with optional filters. Use when you need to retrieve the total number of issues matching specific criteria without fetching the full list.

Input Parameters

string
Filter by one or more issue IDs.
string ("asc" | "desc")
Sort direction: asc or desc.
string
Cursor for next page of results.
string
Cursor for previous page of results.
string
Filter by issue types: delivery, transformation, backpressure.
integer
Page size for pagination (1-250).
string
Filter by issue statuses: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED.
string
Sort key(s).
object
Filter by creation timestamp using operators (gte, gt, lte, lt).
string
Filter by one or more merged issue IDs.
object
Filter by dismissed timestamp using operators (gte, gt, lte, lt).
object
Filter by last seen timestamp using operators (gte, gt, lte, lt).
object
Filter by first seen timestamp using operators (gte, gt, lte, lt).
object
Filter by aggregation keys as a JSON object.
string
Filter by one or more issue trigger IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_ISSUE_TRIGGERTool to retrieve a single Hookdeck issue trigger by its ID. Use when you need to get detailed information about a specific issue trigger configuration.

Input Parameters

string
required
The unique identifier of the issue trigger to retrieve. Issue trigger IDs start with ‘it_’ prefix (e.g., ‘it_GpSukz3t969g2g’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_ISSUE_TRIGGERSTool to list issue triggers for your Hookdeck account. Use when you need to retrieve configured issue triggers and their notification settings.

Input Parameters

string
Sort direction: asc or desc.
string
Filter by issue trigger name.
string
The ID to provide in the query to get the next set of results.
string
The ID to provide in the query to get the previous set of results.
string
Filter by issue trigger type.
integer
Result set size (1-250). Default: 100.
string
Sort key for the results.
string
Date when the issue trigger was disabled (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_QUEUE_DEPTH_METRICSTool to query queue depth metrics for destinations (pending events count and age). Use when you need to analyze event queue depth over time, monitor pending events, or track the age of the oldest pending event for destinations.

Input Parameters

object
Filter criteria for the metrics query (e.g., filter by destination ID or other dimensions).
array
required
Metrics to calculate. Must be one or more of: max_depth (pending events count), max_age (age of oldest pending event). At least one measure is required.
object
required
Date range with start and end timestamps in ISO 8601 format. Required for the query.
array
Dimensions to group metrics by (e.g., ‘destination_id’, ‘source_id’). Results will be grouped by these dimensions.
string
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). If not specified, API defaults to single bucket for entire range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_REQUESTRetrieve details of a Hookdeck request by ID, including processing and verification information, event counts, and request body, headers, and query parameters when available.

Input Parameters

string
required
ID of the Hookdeck request to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_REQUEST_BULK_RETRIESTool to retrieve bulk retry operations for Hookdeck requests. Use when you need to check the status of request bulk retry jobs, monitor their progress, or list historical request bulk retry operations.

Input Parameters

string
Filter by one or more bulk retry IDs.
string
Sort direction for results: ‘asc’ for ascending or ‘desc’ for descending.
string
Cursor token to fetch the next page of results. Provided in pagination object of previous response.
string
Cursor token to fetch the previous page of results. Provided in pagination object of previous response.
integer
Maximum number of results to return per page.
object
Filter properties for the requests to be included in the bulk retry, using query parameters of Requests endpoint (e.g., status, source_id, verified).
string
Sort key for results. Common values: ‘created_at’, ‘updated_at’.
string
Filter by date the bulk retry was created. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
boolean
Filter by whether the bulk retry is currently in progress. True for running operations, false for completed or cancelled.
string
Filter by date the bulk retry was cancelled. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
string
Filter by date the bulk retry completed. Can be an ISO-8601 timestamp or an object with operators (gte, lte, gt, lt).
boolean
Allow partial filter match on query property. When true, relaxes exact matching requirements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_REQUEST_BULK_RETRYTool to retrieve the status of a requests bulk retry operation. Use when you need to check the progress or completion status of a bulk retry job for webhook requests.

Input Parameters

string
required
Bulk retry ID to retrieve (e.g., ‘bch_NEDn7bKfOOcurI’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_REQUEST_EVENTSTool to retrieve events associated with a specific Hookdeck request. Use when you need to get all events that were created from a particular request.

Input Parameters

string
required
Request ID to retrieve events for
string ("asc" | "desc")
Sort direction
string
URL Encoded string of the JSON to match to the data body
string
The ID to provide in the query to get the next set of results
string
URL Encoded string of the value to match partially to the path
string
The ID to provide in the query to get the previous set of results
integer
Result set size
string
Filter by CLI IDs. ?[any]=true operator for any CLI.
string
Filter by lifecycle status of the event
string
URL Encoded string of the JSON to match to the data headers
string
Include the data object in the event model
string
Filter by number of attempts
string
Filter by issue ID
string
Sort key
string
Filter by source IDs
string
Filter by created_at date using a date operator
string
Filter by error code
string
Filter by connection (webhook) IDs
string
Filter by CLI user ID
string
URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)
string
Filter by bulk retry ID
string
Filter by event data ID
string
Filter by successful_at date using a date operator
string
Filter by destination IDs
string
Filter by last_attempt_at date using a date operator
string
Filter by next_attempt_at date using a date operator
string
Filter by HTTP response status code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_REQUEST_IGNORED_EVENTSRetrieve the list of ignored events for a specific Hookdeck request. Use this tool when you need to inspect why certain events were ignored for a particular request. The request ID can be obtained from the HOOKDECK_GET_REQUESTS action. Returns a paginated list of ignored events with their causes and metadata.

Input Parameters

string
required
Request ID to retrieve ignored events for
string
Sort direction(s) for the response
string
The ID to provide in the query to get the next set of results
string
The ID to provide in the query to get the previous set of results
integer
Result set size for pagination
string
Sort key(s) for the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_REQUEST_RAW_BODYTool to retrieve the raw body data of a request. Use when you need to access the original unmodified request body payload of a Hookdeck request.

Input Parameters

string
required
Request ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_REQUESTSTool to list Hookdeck requests. Use when you need to retrieve requests with optional filters and pagination.

Input Parameters

string
Filter by one or more request IDs.
string ("asc" | "desc")
Sort direction (asc or desc).
object
Partial JSON match against request body.
string
Cursor for next page of results.
string
Partial string match against the request path.
string
Cursor for previous page of results.
integer
Page size (1-255).
string ("accepted" | "rejected")
Filter by request status.
object
Partial JSON match against request headers.
string ("ingested_at" | "created_at")
Sort key for results.
boolean
Filter by whether the request was verified.
string
Filter by one or more source IDs.
string
Filter by request ingestion timestamp. Accepts ISO-8601 string or operators dict like {‘gte’: ‘2023-01-01T00:00:00Z’}.
string
Filter by number of events created (excluding CLI events). Accepts integer, list, or operators dict.
object
Partial JSON match against parsed query parameters.
string
Filter by ignored events count. Accepts a single integer, list of integers, or operators dict like {‘gte’: 5}.
string
Filter by one or more rejection causes.
string
Filter by number of CLI events created. Accepts integer, list, or operators dict.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_REQUESTS_METRICSTool to query aggregated request metrics with time-based grouping and filtering. Use when you need to analyze request patterns over time, calculate statistics like request counts, or group metrics by dimensions such as status or source.

Input Parameters

object
Additional filters to apply to the metrics query
array
required
Metrics to calculate (e.g., ‘count’)
object
required
Date range with start and end timestamps in ISO 8601 format
array
Dimensions to group metrics by
string
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’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_SOURCETool to retrieve details of a specific Hookdeck source. Use after confirming the source ID.

Input Parameters

string
Optional include parameter. Use ‘config.auth’ to include authentication credentials in the response config object.
string
required
ID of the source to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_SOURCESTool to retrieve all sources associated with your Hookdeck account. Use when you need to list or filter hook sources.

Input Parameters

string
Filter by source IDs.
string ("asc" | "desc")
Sort direction used in the response; defaults to desc if omitted.
string
Filter by source name; supports string operators such as contains.
string
ID to get the next page of results. Value must come from the previous response’s pagination cursor, not constructed manually.
string
ID to get the previous page of results.
string
Filter by source type.
integer
Result set size (max 255).
boolean
Include disabled resources in the response.
string ("name" | "created_at" | "updated_at")
Sort key used in the response; defaults to created_at if omitted.
object
Filter by date disabled; use operators gte, gt, lte, lt, e.g., {‘gte’: ‘2021-01-01’}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_TRANSFORMATIONRetrieves the complete details of a specific Hookdeck transformation by its ID. Use this tool when you need to inspect a transformation’s JavaScript code, environment variables, or metadata. Requires a valid transformation_id which can be obtained from HOOKDECK_GET_TRANSFORMATIONS. Returns the transformation’s code, name, environment variables, and timestamps.

Input Parameters

string
required
The unique identifier of the transformation to retrieve. Transformation IDs start with ‘trs_’ prefix (e.g., ‘trs_abc123def456’). Use HOOKDECK_GET_TRANSFORMATIONS to list available transformation IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_TRANSFORMATION_EXECUTIONRetrieve a specific transformation execution by transformation ID and execution ID. Use this tool to inspect execution details including original and transformed event data, logs, and any issues that occurred.

Input Parameters

string
required
The unique identifier of the transformation execution (starts with ‘reqt_’ prefix, e.g., ‘reqt_RPezSv8BLk9n0Tl5fK’).
string
required
The unique identifier of the transformation (starts with ‘trs_’ prefix, e.g., ‘trs_wewrYkuM4iXJeh’). Use HOOKDECK_GET_TRANSFORMATIONS to list available transformation IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_TRANSFORMATION_EXECUTIONSTool to retrieve executions for a specific Hookdeck transformation. Use when you need to inspect transformation execution logs, debug transformation failures, or analyze transformation performance.

Input Parameters

string
required
Transformation ID to retrieve executions for. Must be a valid transformation ID (starts with ‘trs_’ prefix).
string
Sort direction(s) - ‘asc’ for ascending or ‘desc’ for descending.
string
Cursor for fetching the next page of results.
string
Cursor for fetching the previous page of results.
integer
Result set size - maximum number of results per page.
string
Filter by associated issue ID.
string
Sort key(s) for ordering results (e.g., ‘created_at’).
string
Filter by log level of the execution (e.g., ‘info’, ‘warn’, ‘error’).
string
Filter by ISO date of the transformation’s execution (e.g., ‘2025-01-01T00:00:00Z’).
string
Filter by connection (webhook) ID that the execution was run for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_TRANSFORMATIONSTool to list Hookdeck transformations. Use when you need to retrieve or filter your Hookdeck transformations.

Input Parameters

string
Filter by transformation IDs.
string ("asc" | "desc")
Sort direction used for this response.
string
Filter by transformation name; supports string operators such as contains.
string
Cursor for next page of results.
string
Cursor for previous page of results.
integer
Page size; maximum of 255.
string ("name" | "created_at" | "updated_at")
Sort key used for this response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_TRANSFORMATIONS_COUNTTool to get the count of Hookdeck transformations with optional filters. Use when you need to get the total number of transformations without retrieving full details.

Input Parameters

string
Filter by transformation IDs.
string
Filter by transformation name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_GET_TRANSFORMATIONS_METRICSTool to query aggregated transformation execution metrics with time-based grouping and filtering. Use when you need to analyze transformation patterns over time, calculate statistics like execution counts, or group metrics by dimensions such as transformation_id or status.

Input Parameters

object
Additional filters to apply to the metrics query
array
required
Metrics to calculate (e.g., ‘count’)
object
required
Date range with start and end timestamps in ISO 8601 format
array
Dimensions to group metrics by
string
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’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_LIST_BOOKMARKSTool to list bookmarks. Use when you need to retrieve your Hookdeck account’s bookmarks with optional filters and pagination. Use after authenticating your session.

Input Parameters

string
Filter by one or more bookmark IDs (prefixed with ‘bmk_’)
string ("asc" | "desc")
Sort direction: ‘asc’ or ‘desc’
string
Cursor for next page
string
Cursor for previous page
string
Filter by bookmark label (the descriptive name given to the bookmark)
integer
Page size limit (1-255)
string
Field to order by, e.g., ‘created_at’ or ‘last_used_at’
string
Filter by one or more connection IDs (prefixed with ‘web_’)
string
Filter by one or more event data IDs (prefixed with ‘edt_‘)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_LIST_CUSTOM_DOMAINSTool to list all custom domains and their verification statuses for the Hookdeck project. Use when you need to view configured custom domains, check their verification status, or monitor SSL certificate details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_LIST_ISSUESTool to list all issues detected in your Hookdeck account. Use when you need to retrieve and filter issues by type, status, or time.

Input Parameters

string
Filter by one or more issue IDs.
string ("asc" | "desc")
Sort direction: asc or desc.
string
Cursor for next page of results.
string
Cursor for previous page of results.
string
Filter by issue types: delivery, transformation, backpressure.
integer
Page size for pagination (1-250).
string
Filter by issue statuses: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED.
string
Sort key(s).
object
Filter by creation timestamp using operators (gte, gt, lte, lt).
string
Filter by one or more merged issue IDs.
object
Filter by dismissed timestamp using operators (gte, gt, lte, lt).
object
Filter by last seen timestamp using operators (gte, gt, lte, lt).
object
Filter by first seen timestamp using operators (gte, gt, lte, lt).
object
Filter by aggregation keys as a JSON object.
string
Filter by one or more issue trigger IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_PAUSE_CONNECTIONTool to pause a Hookdeck connection. Use when you need to temporarily stop event delivery for a connection without deleting it.

Input Parameters

string
required
ID of the connection to pause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_PUBLISH_EVENTTool to publish a webhook event to Hookdeck using the Publish API. Use when testing webhook flows or sending events from your application.

Input Parameters

object
required
JSON payload containing the event data to publish. Can include any fields like event_type, order_id, data, etc. This becomes the webhook body.
string
required
Name of the source to publish to. This will be passed in the X-Hookdeck-Source-Name header. The source must exist in your Hookdeck project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_REPLAY_EVENTReplay (retry) a specific Hookdeck event delivery. Use this to manually retry a failed or queued event. The event will be re-queued for delivery to its destination. After replay, Hookdeck will attempt to deliver the event; if successful, any scheduled automatic retries will be canceled. Note: The event’s connection must still be active - events with deleted connections cannot be replayed.

Input Parameters

string
required
The unique identifier of the Hookdeck event to replay. Must be a valid event ID starting with ‘evt_’. The event’s connection must still be active.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_RESOLVE_ISSUETool to resolve a Hookdeck issue. Use after confirming the underlying issue has been addressed.

Input Parameters

string
required
ID of the issue to resolve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_RETRIEVE_ISSUERetrieves detailed information about a specific Hookdeck issue by its ID. Use this tool when you need to get complete details about a known issue, including its status, type (delivery/transformation/backpressure), aggregation keys, timestamps, and reference information. To find issue IDs, use the List Issues action first.

Input Parameters

string
required
The unique identifier of the issue to retrieve. Issue IDs start with ‘iss_’ prefix (e.g., ‘iss_abc123’). Use the List Issues action to find valid issue IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_SEND_SOURCE_REQUESTTool to send HTTP requests to a Hookdeck Source URL. Use when ingesting test payloads to generate events for testing HOOKDECK_GET_EVENT.

Input Parameters

string
Optional JSON-compatible payload for POST/PUT/PATCH requests; serialized as JSON.
string
Optional path appended after the source_id; must start with ’/’.
object
Optional query parameters. Supports Hookdeck flags like x-hookdeck-allow-methods and x-hookdeck-response variants.
string ("GET" | "POST" | "PUT" | "PATCH" | "DELETE")
HTTP method to use. GET is allowed only if enabled in the Source settings or via the x-hookdeck-allow-methods query parameter.
object
Optional headers to include; do not include Hookdeck REST API auth headers.
string
required
The unique URL segment from the source’s ingest URL (e.g., ‘aj3f7wm89u1enh’ from ‘https://hkdk.events/aj3f7wm89u1enh’). Obtain this from HOOKDECK_GET_SOURCES or HOOKDECK_GET_SOURCE by extracting the last path segment from the ‘url’ field. This is NOT the source’s internal ID (src_xxx).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_TEST_TRANSFORMATIONTool to test a Hookdeck transformation code before deploying it. Use when you need to verify that transformation JavaScript code works correctly with sample request data.

Input Parameters

object
Key-value environment variables to be passed to the transformation during execution.
string
required
JavaScript code to be executed for testing. Must use addHandler(‘transform’, (request, context) => { … }) syntax. The handler receives request (with headers, body, query, parsed_query, path) and context parameters.
object
required
Request input to use for the transformation execution. Must include at minimum the headers field.
string
Optional event ID to use for the test execution context.
string
ID of the connection (webhook) to use for the execution context.
string
Optional transformation ID to use for the test execution. If provided, the code from this transformation will be used instead of the code parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_TOGGLE_WEBHOOK_NOTIFICATIONSTool to toggle webhook notifications for the project. Use when you need to enable or disable webhook notifications and configure which topics to receive.

Input Parameters

array
required
List of notification topics to subscribe to. Available topics: issue.opened, issue.updated, deprecated.attempt-failed, event.successful.
boolean
required
Enable or disable webhook notifications on the project. Set to true to enable, false to disable.
string
required
The Hookdeck Source ID to send the webhook notifications to (e.g., ‘src_1234567890abcdef’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_TRIGGER_BOOKMARKTrigger a Hookdeck bookmark to replay its stored webhook request. When triggered, a new event is created from the bookmarked request data and delivered to the associated destination. This is useful for testing webhook handlers or replaying specific scenarios during development. Note: The bookmark must be associated with an active connection (webhook). Triggering a bookmark with a deleted connection will fail with a 404 error.

Input Parameters

string
required
The unique identifier of the bookmark to trigger. This replays the stored webhook request associated with the bookmark, creating a new event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UNPAUSE_CONNECTIONTool to unpause a paused Hookdeck connection. Use when you need to resume event processing for a previously paused connection.

Input Parameters

string
required
The unique ID of the connection to unpause (e.g., ‘web_NvdMyXJDYXDr’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPDATE_BOOKMARKTool to update an existing bookmark in Hookdeck. Use when you need to modify a bookmark’s label, name, associated event data, or connection. At least one field (label, name, event_data_id, or webhook_id) must be provided for the update.

Input Parameters

string
New unique, human-friendly name for the bookmark. Must contain only alphanumeric characters, hyphens, and underscores (pattern: ^[A-z0-9-_]+$). Maximum 155 characters.
string
New descriptive name for the bookmark shown in the Hookdeck UI and CLI. Maximum 255 characters.
string
New connection (webhook) ID to associate with this bookmark. Obtain from HOOKDECK_GET_CONNECTIONS. Maximum 255 characters.
string
required
The unique identifier of the bookmark to update (prefixed with ‘bmk_’)
string
New event data ID to associate with this bookmark. Obtain from event objects via HOOKDECK_GET_EVENTS. Maximum 255 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPDATE_CONNECTIONUpsert (create or update) a Hookdeck connection between a source and destination. The connection is identified by the source and destination combination. If a connection with the given source and destination exists, it will be updated. Otherwise, a new connection is created. Use this tool to: - Create a new connection between a source and destination - Update an existing connection’s name, description, or rules - Configure webhook routing with retry, filter, or transform rules

Input Parameters

string
Unique name for the connection; alphanumeric with hyphens/underscores, max 155 chars
array
Array of rules for the connection (e.g., retry, filter, transform, delay)
object
Source specification for the connection (by name or for inline creation).
string
ID of an existing source. Mutually exclusive with ‘source’.
string
Human-readable description for the connection; max 500 chars
object
Destination specification for the connection (by name or for inline creation).
string
ID of an existing destination. Mutually exclusive with ‘destination’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPDATE_CONNECTION2Tool to update an existing Hookdeck connection by its ID. Use when you need to modify a connection’s description, name, or rules.

Input Parameters

string
required
Connection ID to update
string
Name for the connection; alphanumeric with hyphens/underscores, max 155 chars
array
Array of rules configured on the connection (retry, filter, transform, delay, deduplicate)
string
Description for the connection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPDATE_DESTINATIONTool to update an existing Hookdeck destination. Use when you need to modify a destination’s settings after creation.

Input Parameters

string
New name for the destination. Pattern: ^[A-Za-z0-9-_]+$, max length 155
string ("HTTP" | "CLI" | "MOCK_API")
Destination type
object
Configuration for a Hookdeck destination.
string
Description for the destination, max length 500
string
required
ID of the destination to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPDATE_INTEGRATIONTool to update an existing Hookdeck integration. Use when you need to modify integration configuration, change labels, update provider settings, or enable/disable features.

Input Parameters

string
required
Integration ID to update
string
Label of the integration for easy identification.
object
Decrypted key/value object of the associated configuration for the provider. Required fields vary by provider (e.g., ‘api_key’ for API_KEY provider, ‘webhook_secret_key’ for HMAC, ‘username’ and ‘password’ for BASIC_AUTH).
array
List of features to enable for this integration.
string ("AIPRISE" | "DOCUSIGN" | "INTERCOM" | "HMAC" | "BASIC_AUTH" | "API_KEY" | "MANAGED" | "HOOKDECK_OUTPOST" | "SANITY" | "BIGCOMMERCE" | "OPENAI" | "POLAR" | "BRIDGE" | "CHARGEBEE_BILLING" | "CLOUDSIGNAL" | "COINBASE" | "COURIER" | "CURSOR" | "MERAKI" | "FIREBLOCKS" | "FRONTAPP" | "ZOOM" | "TWITTER" | "RECHARGE" | "RECURLY" | "RING_CENTRAL" | "STRIPE" | "PROPERTY-FINDER" | "QUOTER" | "SHOPIFY" | "TWILIO" | "GITHUB" | "POSTMARK" | "TALLY" | "TYPEFORM" | "PICQER" | "XERO" | "SVIX" | "RESEND" | "ADYEN" | "AKENEO" | "GITLAB" | "WOOCOMMERCE" | "OKTA" | "OURA" | "COMMERCELAYER" | "HUBSPOT" | "MAILGUN" | "PERSONA" | "PIPEDRIVE" | "SENDGRID" | "WORKOS" | "SYNCTERA" | "AWS_SNS" | "THREE_D_EYE" | "TWITCH" | "ENODE" | "FAVRO" | "LINEAR" | "SHOPLINE" | "WIX" | "NMI" | "ORB" | "PYLON" | "RAZORPAY" | "REPAY" | "SQUARE" | "SOLIDGATE" | "TRELLO" | "EBAY" | "TELNYX" | "DISCORD" | "TOKENIO" | "FISERV" | "FUSIONAUTH" | "BONDSMITH" | "VERCEL_LOG_DRAINS" | "VERCEL" | "TEBEX" | "SLACK" | "SMARTCAR" | "MAILCHIMP" | "NUVEMSHOP" | "PADDLE" | "PAYPAL" | "PORTAL" | "TREEZOR" | "PRAXIS" | "CUSTOMERIO" | "EXACT_ONLINE" | "FACEBOOK" | "WHATSAPP" | "REPLICATE" | "TIKTOK" | "TIKTOK_SHOP" | "AIRWALLEX" | "ASCEND" | "ALIPAY" | "ZENDESK" | "UPOLLO" | "SMILE" | "NYLAS" | "CLIO" | "GOCARDLESS" | "LINKEDIN" | "LITHIC" | "UTILA" | "ZEROHASH" | "AIRTABLE" | "ASANA" | "FASTSPRING" | "PAYPRO_GLOBAL" | "USPS" | "FLEXPORT")
Supported integration providers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPDATE_ISSUE_TRIGGERUpdate an existing Hookdeck issue trigger’s name, notification channels, configuration, or disabled timestamp. The disabled timestamp can be set but cannot be cleared with this tool.

Input Parameters

string
required
Issue trigger ID to update. Obtain this from list issue triggers endpoint.
string
Optional unique name to reference the issue trigger via API.
object
Configuration object based on issue type. For delivery: {strategy: ‘first_attempt’, connections: ''}. For transformation: {log_level: ‘error’, transformations: ''}. For backpressure: {delay: 1000, destinations: ’*’}.
object
Notification channels configuration. At least one channel must be specified.
string
ISO timestamp for when the issue trigger was disabled. Set to null to enable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPDATE_SOURCEUpdate an existing Hookdeck source’s name, type, or description. Use this tool when you need to: - Rename a source - Change a source’s type (e.g., from WEBHOOK to STRIPE) - Update or add a description to a source Note: Source configuration (allowed_http_methods, auth settings) cannot be updated via this endpoint. At least one field (name, type, or description) must be provided.

Input Parameters

string
New unique name for the source. Must contain only alphanumeric characters, hyphens, and underscores (pattern: ^[A-Za-z0-9-_]+$). Maximum 155 characters.
string ("ADYEN" | "AIPRISE" | "AIRWALLEX" | "AKENEO" | "ALIPAY" | "AWS_SNS" | "BIGCOMMERCE" | "BONDSMITH" | "BRIDGE" | "CLIO" | "CLOUDSIGNAL" | "COMMERCELAYER" | "COURIER" | "CUSTOMERIO" | "DISCORD" | "DOCUSIGN" | "EBAY" | "ENODE" | "EXACT_ONLINE" | "FACEBOOK" | "FAVRO" | "FIREBLOCKS" | "FISERV" | "FRONTAPP" | "GITHUB" | "GITLAB" | "GOCARDLESS" | "HTTP" | "HUBSPOT" | "INTERCOM" | "LINEAR" | "LINKEDIN" | "MAILCHIMP" | "MAILGUN" | "MANAGED" | "MERAKI" | "MONDAY" | "NMI" | "NUVEMSHOP" | "NYLAS" | "OKTA" | "OPENAI" | "ORB" | "OURA" | "PADDLE" | "PAYPAL" | "PERSONA" | "PICQER" | "PIPEDRIVE" | "POLAR" | "POSTMARK" | "PRAXIS" | "PROPERTY-FINDER" | "PUBLISH_API" | "PYLON" | "QUOTER" | "RAZORPAY" | "RECHARGE" | "REPAY" | "REPLICATE" | "RING_CENTRAL" | "SANITY" | "SENDGRID" | "SHOPIFY" | "SHOPLINE" | "SLACK" | "SMILE" | "SOLIDGATE" | "SQUARE" | "STRAVA" | "STRIPE" | "SVIX" | "SYNCTERA" | "TALLY" | "TEBEX" | "TELNYX" | "THREE_D_EYE" | "TIKTOK" | "TIKTOK_SHOP" | "TOKENIO" | "TREEZOR" | "TRELLO" | "TWILIO" | "TWITCH" | "TWITTER" | "TYPEFORM" | "UPOLLO" | "UTILA" | "VERCEL" | "VERCEL_LOG_DRAINS" | "WEBHOOK" | "WHATSAPP" | "WIX" | "WOOCOMMERCE" | "WORKOS" | "XERO" | "ZENDESK" | "ZEROHASH" | "ZIFT" | "ZOOM")
New source type. Changing the type updates the source’s expected webhook format and verification method. Common types: WEBHOOK (generic), STRIPE, GITHUB, SHOPIFY, etc.
string
required
The unique identifier of the source to update (e.g., ‘src_1234567890abcdef’). Required.
string
New human-readable description for the source. Maximum 500 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPDATE_TRANSFORMATIONTool to update an existing Hookdeck transformation. Use when you need to modify a transformation’s code, name, or environment variables after creation.

Input Parameters

object
Environment variables for the transformation as string key-value pairs.
string
JavaScript code to be executed in the transformation. Use addHandler(‘transform’, (request, context) => { … }) syntax.
string
A unique, human-friendly name for the transformation. Must match pattern ^[A-Za-z0-9-_]+$ and be at most 155 characters.
string
required
ID of the transformation to update (starts with ‘trs_‘)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPSERT_DESTINATIONCreate or update a Hookdeck destination by name for event routing. The request sends type HTTP when no type is specified, including when updating an existing destination.

Input Parameters

string
required
Unique destination name; letters, numbers, hyphens, or underscores only; max 155 chars.
string ("HTTP" | "CLI" | "MOCK_API")
Destination type; one of HTTP, CLI, or MOCK_API. Defaults to HTTP.
object
Configuration object for the destination; fields vary by destination type.
string
Human-readable description of the destination; max 500 chars.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPSERT_ISSUE_TRIGGERTool to create or update an issue trigger in Hookdeck using upsert semantics. If a trigger with the given name exists, it will be updated; otherwise, a new trigger is created.

Input Parameters

string
required
Required unique name to reference the issue trigger via API. Used to identify the trigger for upsert operations.
string ("delivery" | "transformation" | "backpressure")
required
Issue type: ‘delivery’, ‘transformation’, or ‘backpressure’.
object
Configuration object based on issue type. For delivery: {strategy: ‘first_attempt’, connections: ''}. For transformation: {log_level: ‘error’, transformations: []}. For backpressure: {delay: 1000, destinations: ''}.
object
required
Notification channels configuration. At least one channel must be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPSERT_SOURCECreate or update a Hookdeck source by name. The request sends type WEBHOOK when no type is specified, including when updating an existing source.

Input Parameters

string
required
Unique name for the source. Must contain only alphanumeric characters, hyphens, and underscores. Maximum 155 characters. If a source with this name exists, it will be updated; otherwise, a new source is created.
string ("AIPRISE" | "DOCUSIGN" | "INTERCOM" | "PUBLISH_API" | "WEBHOOK" | "HTTP" | "MANAGED" | "HOOKDECK_OUTPOST" | "SANITY" | "BIGCOMMERCE" | "OPENAI" | "POLAR" | "BRIDGE" | "CHARGEBEE_BILLING" | "CLOUDSIGNAL" | "COINBASE" | "COURIER" | "CURSOR" | "MERAKI" | "FIREBLOCKS" | "FRONTAPP" | "ZOOM" | "TWITTER" | "RECHARGE" | "RECURLY" | "RING_CENTRAL" | "STRIPE" | "PROPERTY-FINDER" | "QUOTER" | "SHOPIFY" | "TWILIO" | "GITHUB" | "POSTMARK" | "TALLY" | "TYPEFORM" | "PICQER" | "XERO" | "SVIX" | "RESEND" | "ADYEN" | "AKENEO" | "GITLAB" | "WOOCOMMERCE" | "OKTA" | "OURA" | "COMMERCELAYER" | "HUBSPOT" | "MAILGUN" | "PERSONA" | "PIPEDRIVE" | "SENDGRID" | "WORKOS" | "SYNCTERA" | "AWS_SNS" | "THREE_D_EYE" | "TWITCH" | "ENODE" | "FAVRO" | "LINEAR" | "SHOPLINE" | "WIX" | "NMI" | "ORB" | "PYLON" | "RAZORPAY" | "REPAY" | "SQUARE" | "SOLIDGATE" | "TRELLO" | "EBAY" | "TELNYX" | "DISCORD" | "TOKENIO" | "FISERV" | "FUSIONAUTH" | "BONDSMITH" | "VERCEL_LOG_DRAINS" | "VERCEL" | "TEBEX" | "SLACK" | "SMARTCAR" | "MAILCHIMP" | "NUVEMSHOP" | "PADDLE" | "PAYPAL" | "PORTAL" | "TREEZOR" | "PRAXIS" | "CUSTOMERIO" | "EXACT_ONLINE" | "FACEBOOK" | "WHATSAPP" | "REPLICATE" | "TIKTOK" | "TIKTOK_SHOP" | "AIRWALLEX" | "ASCEND" | "ALIPAY" | "ZENDESK" | "UPOLLO" | "SMILE" | "NYLAS" | "CLIO" | "GOCARDLESS" | "LINKEDIN" | "LITHIC" | "STRAVA" | "UTILA" | "MONDAY" | "ZEROHASH" | "ZIFT" | "ETHOCA" | "AIRTABLE" | "ASANA" | "FASTSPRING" | "PAYPRO_GLOBAL" | "USPS" | "FLEXPORT")
Type of the source. Defaults to ‘WEBHOOK’ for generic webhooks. Common types include STRIPE, GITHUB, SHOPIFY, etc.
object
Configuration object for the source; structure varies by source type.
string
Human-readable description of the source. Maximum 500 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOOKDECK_UPSERT_TRANSFORMATIONTool to create or update a Hookdeck transformation by name. Use when you want to ensure a transformation exists with specific code, creating it if it doesn’t exist or updating it if it does.

Input Parameters

object
Key-value environment variables to pass to the transformation code at runtime.
string
required
JavaScript code to be executed in the transformation. The code transforms webhook payloads before delivery.
string
required
A unique, human-friendly name for the transformation. Must match pattern ^[A-Za-z0-9-_]+$ and be at most 155 characters. If a transformation with this name exists, it will be updated; otherwise, a new one will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not