Hookdeck

Filter object specifying conditions for selecting events to cancel.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter object specifying conditions for selecting events to retry.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the event to cancel

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the event to mute scheduled retries for

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Descriptive name for the bookmark shown in UI.

ID of the associated connection (webhook).

ID of the event data to bookmark.

Unique bookmark ID.

Snapshot of the original event request data at bookmark time.

Optional alternate alias for the bookmark.

Error if any occurred during the execution of the action

Bookmark label.

Project/workspace ID.

When the bookmark was created.

Whether or not the action execution was successful or not

When the bookmark was last updated.

Associated connection (webhook) ID.

When the bookmark was last manually triggered.

Bookmarked event data ID.

Optional unique name for the connection.

Optional list of retry rules for the connection.

Inline input for creating a source.

ID of an existing source to bind to this connection.

Optional human-readable description for the connection.

Inline input for creating a destination.

ID of an existing destination to bind to this connection.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique destination name; letters, numbers, hyphens, or underscores only; max 155 chars.

Destination type; one of HTTP, CLI, or MOCK_API. Defaults to HTTP.

Configuration object specific to the chosen destination type.

Human-readable description of the destination.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique source name; letters, numbers, hyphens, or underscores only; max 155 chars.

Predefined source type. Omit for a generic webhook source.

Configuration object for the source; fields vary by source type.

Human-readable description of the source.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Key-value environment variables to pass to the transformation.

JavaScript code to execute for the transformation.

Unique transformation name; letters, numbers, hyphens, or underscores only; max 155 chars.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of the bookmark to permanently delete

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of the connection to permanently delete

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of the destination to permanently delete

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of the source to permanently delete

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The unique identifier of the transformation to permanently delete

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the Hookdeck attempt to retrieve

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by one or more attempt IDs.

Sort direction(s), e.g., asc or desc.

Cursor to fetch the next page.

Cursor to fetch the previous page.

Page size; max 255.

Filter by one or more event IDs associated with the attempts.

Sort key(s) to order results by.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the connection to retrieve

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by one or more connection IDs.

Sort direction: asc or desc. Default: desc.

Cursor for next page of results.

Cursor for previous page of results.

Page size: integer between 1 and 250. Defaults to 100.

Include disabled connections if true.

Sort key(s). Default: created_at.

Fuzzy match on combined 'source -> connection' name.

Filter by paused date using operators (gte, gt, lte, lt).

Filter by one or more source IDs.

Filter by disabled date using operators (gte, gt, lte, lt).

Filter by one or more destination IDs.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the destination to retrieve

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by one or more destination IDs.

Sort direction: asc or desc. Defaults to desc.

Filter by one or more destination names.

Cursor for next page.

Cursor for previous page.

Filter by destination type. Allowed values: HTTP, CLI, MOCK_API.

Page size: integer between 1 and 255. Defaults to 100.

Include disabled destinations if true.

Sort key: name, created_at, or updated_at. Defaults to created_at.

Filter destinations disabled at a specific timestamp or with operators.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by one or more event IDs.

Sort direction: asc or desc; default is 'desc'.

Cursor to fetch the next page.

Cursor to fetch the previous page.

Page size; default 100; max 250.

Filter by event lifecycle status (e.g., SUCCESSFUL, QUEUED, FAILED).

Filter by number of delivery attempts with operators. E.g., {'gte': 2, 'lte': 5}.

Sort key; default is 'created_at'.

Filter by one or more source IDs.

Filter by event creation timestamp with operators. E.g., {'gte': '2023-01-01T00:00:00Z'}.

Filter by one or more connection (webhook) IDs.

Filter by one or more destination IDs.

Filter by HTTP response status code(s) or with operators. E.g., 200, [200,404], or {'gte':400}.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the Hookdeck request to retrieve

Request ID

Detailed original request data for the Hookdeck request.

Error if any occurred during the execution of the action

Team (project) ID

Whether the request was verified when received

ID of the associated source

Creation timestamp of the request

Whether or not the action execution was successful or not

Last update timestamp of the request

Timestamp when the request was ingested

Number of events created from this request

Service tier for this request

Count of ignored events

Reason the request was rejected, if applicable

Number of CLI events created from this request

ID of the original event data record

Filter by one or more request IDs.

Sort direction (asc or desc).

Partial JSON match against request body.

Cursor for next page of results.

Partial string match against the request path.

Cursor for previous page of results.

Page size (1-255).

Filter by request status.

Partial JSON match against request headers.

Sort key for results.

Filter by whether the request was verified.

Filter by one or more source IDs.

Filter by request ingestion timestamp. Accepts ISO-8601 string or operators dict like {'gte': '2023-01-01T00:00:00Z'}.

Filter by number of events created (excluding CLI events). Accepts integer, list, or operators dict.

Partial JSON match against parsed query parameters.

Filter by ignored events count. Accepts a single integer, list of integers, or operators dict like {'gte': 5}.

Filter by one or more rejection causes.

Filter by number of CLI events created. Accepts integer, list, or operators dict.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by source IDs.

Sort direction used in the response; defaults to desc if omitted.

Filter by source name; supports string operators such as contains.

ID to get the next page of results.

ID to get the previous page of results.

Filter by source type.

Result set size (max 255).

Include disabled resources in the response.

Sort key used in the response; defaults to created_at if omitted.

Filter by date disabled; use operators gte, gt, lte, lt, e.g., {'gte': '2021-01-01'}.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the transformation to retrieve

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by transformation IDs.

Sort direction used for this response.

Filter by transformation name; supports string operators such as contains.

Cursor for next page of results.

Cursor for previous page of results.

Page size; maximum of 255.

Sort key used for this response.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Optional include parameter. For API version 2023-07-01 use 'verification.configs'; for newer versions, 'config.auth' is supported.

ID of the source to retrieve

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Optional JSON-compatible payload for POST/PUT/PATCH requests; serialized as JSON.

Optional path appended after the source_id; must start with '/'.

Optional query parameters. Supports Hookdeck flags like x-hookdeck-allow-methods and x-hookdeck-response variants.

HTTP method to use. GET is allowed only if enabled in the Source settings or via the x-hookdeck-allow-methods query parameter.

Optional headers to include; do not include Hookdeck REST API auth headers.

The unique segment of the Source URL (not the internal object ID).

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by one or more bookmark IDs

Sort direction: 'asc' or 'desc'

Filter by one or more bookmark labels

Cursor for next page

Cursor for previous page

Filter by one or more bookmark aliases or labels

Page size limit (1-255)

Field to order by, e.g., 'created_at' or 'last_used_at'

Filter by one or more webhook (connection) IDs

Filter by one or more event data IDs

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Filter by one or more issue IDs.

Sort direction: asc or desc.

Cursor for next page of results.

Cursor for previous page of results.

Filter by issue types: delivery, transformation, backpressure.

Page size for pagination (1-250).

Filter by issue statuses: OPENED, IGNORED, ACKNOWLEDGED, RESOLVED.

Sort key(s).

Filter by creation timestamp using operators (gte, gt, lte, lt).

Filter by one or more merged issue IDs.

Filter by dismissed timestamp using operators (gte, gt, lte, lt).

Filter by last seen timestamp using operators (gte, gt, lte, lt).

Filter by first seen timestamp using operators (gte, gt, lte, lt).

Filter by aggregation keys as a JSON object.

Filter by one or more issue trigger IDs.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the Hookdeck event to manually retry

Unique identifier of the event

Details of the original event request

Error if any occurred during the execution of the action

CLI session ID if applicable

Current status of the event

ID of the team/project owning the event

Number of delivery attempts

Associated source ID

Timestamp when the event was created

Error code if delivery has failed

Original request ID that triggered the event

Whether or not the action execution was successful or not

Timestamp when the event was last updated

Associated webhook (connection) ID

ID of the event data payload

Timestamp when the event was successfully delivered

Associated destination ID

Timestamp of the last delivery attempt

Timestamp scheduled for the next retry

HTTP status code returned by the destination

ID of the event to replay

Unique identifier of the event

Details of the original event request

Error if any occurred during the execution of the action

CLI session ID if applicable

Current status of the event

ID of the team/project owning the event

Number of delivery attempts

Associated source ID

Timestamp when the event was created

Error code if delivery has failed

Original request ID that triggered the event

Whether or not the action execution was successful or not

Timestamp when the event was last updated

Associated webhook (connection) ID

ID of the event data payload

Timestamp when the event was successfully delivered

Associated destination ID

Timestamp of the last delivery attempt

Timestamp scheduled for the next retry

HTTP status code returned by the destination

ID of the issue to resolve

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

ID of the Hookdeck issue to retrieve

Issue ID

Detailed context data

Issue type

Error if any occurred during the execution of the action

Issue status

Team ID

Opened timestamp

Trigger reference

Creation timestamp

Whether or not the action execution was successful or not

Last update timestamp

Merged issue ID (nullable)

Dismissed timestamp (nullable)

Last seen timestamp

First seen timestamp

Last user who updated the issue

Grouping keys

Auto-resolved timestamp (nullable)

Issue trigger ID

ID of the bookmark to trigger for replaying its stored request

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique name for the connection; pattern ^[A-Za-z0-9-_]+$, max 155 chars

Array of rules for the connection (e.g., retry, filter)

Description for the connection; max 500 chars

ID of the connection to update

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

New name for the destination. Pattern: ^[A-Za-z0-9\-_]+$, max length 155

Destination type

Configuration for a Hookdeck destination.

Description for the destination, max length 500

ID of the destination to update

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique source name; alphanumeric characters, hyphens, and underscores only; pattern ^[A-z0-9-_]+$; max length 155

Type of the source; must be one of the predefined source types

Type-specific configuration object for the source

ID of the source to update

Optional description for the source; max length 500

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Environment variables for the transformation as key-value pairs

JavaScript code to be executed in the transformation

A unique, human-friendly name for the transformation. Pattern: ^[A-Za-z0-9\-_]+$, max length 155

ID of the transformation to update

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not