/hookdeck-events | Type: Application | PCID required: Yes
Tools
hookdeck_events_cancel_event
Cancel an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Event ID |
hookdeck_events_cancel_event_bulk_retry
Cancel an events bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bulk retry ID |
hookdeck_events_cancel_event_mute
Cancel an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Event ID |
hookdeck_events_cancel_ignored_event_bulk_retry
Cancel an ignored events bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bulk retry ID |
hookdeck_events_cancel_request_bulk_retry
Cancel a requests bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bulk retry ID |
hookdeck_events_create_event_bulk_cancel
Create an events bulk cancel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | object | No | — | Filter properties for the events to be included in the bulk cancel |
hookdeck_events_create_event_bulk_retry
Create an events bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | object | No | — | Filter properties for the events to be included in the bulk retry |
hookdeck_events_create_ignored_event_bulk_retry
Create an ignored events bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | object | No | — | Filter by the bulk retry ignored event query object |
hookdeck_events_create_request_bulk_retry
Create a requests bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | object | No | — | Filter properties for the events to be included in the bulk retry, use query parameters of Requests |
hookdeck_events_generate_event_bulk_cancel_plan
Generate an events bulk cancel plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | object | No | — | Filter properties for the events to be included in the bulk cancel |
hookdeck_events_generate_event_bulk_retry_plan
Generate an events bulk retry plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | object | No | — | Filter properties for the events to be included in the bulk retry |
hookdeck_events_generate_ignored_event_bulk_retry_plan
Generate an ignored events bulk retry plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | object | No | — | Filter by the bulk retry ignored event query object |
hookdeck_events_generate_request_bulk_retry_plan
Generate a requests bulk retry plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | object | No | — | Filter properties for the events to be included in the bulk retry, use query parameters of Requests |
hookdeck_events_get_attempt
Get a single attempt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Attempt ID |
hookdeck_events_get_attempts
Get attempts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | ID of the attempt |
event_id | string[] | No | — | Event the attempt is associated with |
order_by | string[] | No | — | Sort key(s) |
dir | string[] | No | — | Sort direction(s) |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_get_event
Get an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Event ID |
hookdeck_events_get_event_bulk_cancel
Get an events bulk cancel Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bulk cancel ID |
hookdeck_events_get_event_bulk_cancels
Get events bulk cancels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cancelled_at | object | No | — | Filter by date the bulk cancel was cancelled |
completed_at | object | No | — | Filter by date the bulk cancel completed |
created_at | object | No | — | Filter by date the bulk cancel was created |
id | string[] | No | — | Filter by bulk cancel IDs |
query | object | No | — | Filter for events to be included in the bulk cancel operation, use query parameters of Event |
query_partial_match | boolean | No | — | Allow partial filter match on query property |
in_progress | boolean | No | — | Indicates if the bulk cancel is currently in progress |
order_by | string[] | No | — | Sort key(s) |
dir | string[] | No | — | Sort direction(s) |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_get_event_bulk_retries
Get events bulk retries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cancelled_at | object | No | — | Filter by date the bulk retry was cancelled |
completed_at | object | No | — | Filter by date the bulk retry completed |
created_at | object | No | — | Filter by date the bulk retry was created |
id | string[] | No | — | Filter by bulk retry IDs |
query | object | No | — | Filter for events to be included in the bulk retry, use query parameters of Event |
query_partial_match | boolean | No | — | Allow partial filter match on query property |
in_progress | boolean | No | — | Indicates if the bulk retry is currently in progress |
order_by | string[] | No | — | Sort key(s) |
dir | string[] | No | — | Sort direction(s) |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_get_event_bulk_retry
Get an events bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bulk retry ID |
hookdeck_events_get_event_raw_body
Get a event raw body data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Event ID |
hookdeck_events_get_events
Get events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by event IDs |
status | string[] | No | — | Lifecyle status of the event |
webhook_id | string[] | No | — | Filter by connection (webhook) IDs |
destination_id | string[] | No | — | Filter by destination IDs |
source_id | string[] | No | — | Filter by source IDs |
attempts | object | No | — | Filter by number of attempts |
response_status | object | No | — | Filter by HTTP response status code |
successful_at | object | No | — | Filter by successful_at date using a date operator |
created_at | object | No | — | Filter by created_at date using a date operator |
error_code | string[] | No | — | Filter by error code code |
cli_id | object | No | — | Filter by CLI IDs. ?[any]=true operator for any CLI. |
last_attempt_at | object | No | — | Filter by last_attempt_at date using a date operator |
next_attempt_at | object | No | — | Filter by next_attempt_at date using a date operator |
search_term | string | No | — | URL Encoded string of the value to match partially to the body, headers, parsed_query or path |
headers | object | No | — | URL Encoded string of the JSON to match to the data headers |
body | object | No | — | URL Encoded string of the JSON to match to the data body |
parsed_query | object | No | — | URL Encoded string of the JSON to match to the parsed query (JSON representation of the query) |
path | string | No | — | URL Encoded string of the value to match partially to the path |
cli_user_id | string[] | No | — | Cli User Id |
issue_id | string[] | No | — | Issue Id |
event_data_id | string[] | No | — | Event Data Id |
bulk_retry_id | string[] | No | — | Bulk Retry Id |
include | string | No | — | Include the data object in the event model |
progressive | string | No | — | Enable progressive loading for partial results |
order_by | string | No | — | Sort key |
dir | string | No | — | Sort direction |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_get_ignored_event_bulk_retries
Get ignored events bulk retries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cancelled_at | object | No | — | Filter by date the bulk retry was cancelled |
completed_at | object | No | — | Filter by date the bulk retry completed |
created_at | object | No | — | Filter by date the bulk retry was created |
id | string[] | No | — | Filter by bulk retry IDs |
query | object | No | — | Filter by the bulk retry ignored event query object |
query_partial_match | boolean | No | — | Allow partial filter match on query property |
in_progress | boolean | No | — | Indicates if the bulk retry is currently in progress |
order_by | string[] | No | — | Sort key(s) |
dir | string[] | No | — | Sort direction(s) |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_get_ignored_event_bulk_retry
Get an ignored events bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bulk retry ID |
hookdeck_events_get_request
Get a request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Request ID |
hookdeck_events_get_request_bulk_retries
Get request bulk retries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cancelled_at | object | No | — | Filter by date the bulk retry was cancelled |
completed_at | object | No | — | Filter by date the bulk retry completed |
created_at | object | No | — | Filter by date the bulk retry was created |
id | string[] | No | — | Filter by bulk retry IDs |
in_progress | boolean | No | — | Indicates if the bulk retry is currently in progress |
query | object | No | — | Filter properties for the events to be included in the bulk retry, use query parameters of Requests |
query_partial_match | boolean | No | — | Allow partial filter match on query property |
order_by | string[] | No | — | Sort key(s) |
dir | string[] | No | — | Sort direction(s) |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_get_request_bulk_retry
Get a requests bulk retry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bulk retry ID |
hookdeck_events_get_request_events
Get request events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | Yes | — | Filter by event IDs |
status | string[] | No | — | Lifecyle status of the event |
webhook_id | string[] | No | — | Filter by connection (webhook) IDs |
destination_id | string[] | No | — | Filter by destination IDs |
source_id | string[] | No | — | Filter by source IDs |
attempts | object | No | — | Filter by number of attempts |
response_status | object | No | — | Filter by HTTP response status code |
successful_at | object | No | — | Filter by successful_at date using a date operator |
created_at | object | No | — | Filter by created_at date using a date operator |
error_code | string[] | No | — | Filter by error code code |
cli_id | object | No | — | Filter by CLI IDs. ?[any]=true operator for any CLI. |
last_attempt_at | object | No | — | Filter by last_attempt_at date using a date operator |
next_attempt_at | object | No | — | Filter by next_attempt_at date using a date operator |
search_term | string | No | — | URL Encoded string of the value to match partially to the body, headers, parsed_query or path |
headers | object | No | — | URL Encoded string of the JSON to match to the data headers |
body | object | No | — | URL Encoded string of the JSON to match to the data body |
parsed_query | object | No | — | URL Encoded string of the JSON to match to the parsed query (JSON representation of the query) |
path | string | No | — | URL Encoded string of the value to match partially to the path |
cli_user_id | string[] | No | — | Cli User Id |
issue_id | string[] | No | — | Issue Id |
event_data_id | string[] | No | — | Event Data Id |
bulk_retry_id | string[] | No | — | Bulk Retry Id |
include | string | No | — | Include the data object in the event model |
progressive | string | No | — | Enable progressive loading for partial results |
order_by | string | No | — | Sort key |
dir | string | No | — | Sort direction |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_get_request_ignored_events
Get request ignored events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | Yes | — | Filter by ignored events IDs |
order_by | string[] | No | — | Sort key(s) |
dir | string[] | No | — | Sort direction(s) |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_get_request_raw_body
Get a request raw body data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Request ID |
hookdeck_events_get_requests
Get requests Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by requests IDs |
status | string | No | — | Filter by status |
rejection_cause | string[] | No | — | Filter by rejection cause |
source_id | string[] | No | — | Filter by source IDs |
verified | boolean | No | — | Filter by verification status |
search_term | string | No | — | URL Encoded string of the value to match partially to the body, headers, parsed_query or path |
headers | object | No | — | URL Encoded string of the JSON to match to the data headers |
body | object | No | — | URL Encoded string of the JSON to match to the data body |
parsed_query | object | No | — | URL Encoded string of the JSON to match to the parsed query (JSON representation of the query) |
path | string | No | — | URL Encoded string of the value to match partially to the path |
ignored_count | object | No | — | Filter by count of ignored events |
events_count | object | No | — | Filter by count of events |
cli_events_count | object | No | — | Filter by count of CLI events |
created_at | object | No | — | Filter by request created date |
ingested_at | object | No | — | Filter by request ingested date |
bulk_retry_id | string[] | No | — | Bulk Retry Id |
include | string | No | — | Related resources to include |
progressive | string | No | — | Enable progressive loading for partial results |
order_by | string | No | — | Sort key |
dir | string | No | — | Sort direction |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_events_query_attempt_metrics
Query attempt metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_range | object | No | — | Date Range |
granularity | string | No | — | 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 |
filters | object | No | — | The filters value |
measures | string[] | No | — | Metrics to calculate |
dimensions | string[] | No | — | Dimensions to group by |
hookdeck_events_query_event_metrics
Query event metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_range | object | No | — | Date Range |
granularity | string | No | — | 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 |
filters | object | No | — | The filters value |
measures | string[] | No | — | Metrics to calculate |
dimensions | string[] | No | — | Dimensions to group by |
hookdeck_events_query_events_by_issue_metrics
Query event metrics grouped by individual issue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_range | object | No | — | Date Range |
granularity | string | No | — | 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 |
filters | object | No | — | The filters value |
measures | string[] | No | — | Metrics to calculate |
dimensions | string[] | No | — | Dimensions to group by |
hookdeck_events_query_events_pending_timeseries_metrics
Query events pending timeseries metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_range | object | No | — | Date Range |
granularity | string | No | — | 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 |
filters | object | No | — | The filters value |
measures | string[] | No | — | List of measures to aggregate (count) |
dimensions | string[] | No | — | List of dimensions to group by |
hookdeck_events_query_queue_depth_metrics
Query queue depth metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_range | object | No | — | Date Range |
granularity | string | No | — | 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 |
filters | object | No | — | The filters value |
measures | string[] | No | — | Metrics to calculate |
dimensions | string[] | No | — | Dimensions to group by |
hookdeck_events_query_request_metrics
Query request metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_range | object | No | — | Date Range |
granularity | string | No | — | 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 |
filters | object | No | — | The filters value |
measures | string[] | No | — | Metrics to calculate |
dimensions | string[] | No | — | Dimensions to group by |
hookdeck_events_query_transformation_metrics
Query transformation execution metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_range | object | No | — | Date Range |
granularity | string | No | — | 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 |
filters | object | No | — | The filters value |
measures | string[] | No | — | Metrics to calculate |
dimensions | string[] | No | — | Dimensions to group by |
hookdeck_events_retry_event
Retry an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Event ID |
hookdeck_events_retry_request
Retry a request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Request ID |
webhook_ids | string[] | No | — | Subset of connection (webhook) IDs to re-run the event logic on. Useful to retry only specific ignored_events. If left empty, all connection (webhook) IDs will be considered. |

