Skip to main content
Server path: /hookdeck-events | Type: Application | PCID required: Yes

Tools

ToolDescription
hookdeck_events_cancel_eventCancel an event
hookdeck_events_cancel_event_bulk_retryCancel an events bulk retry
hookdeck_events_cancel_event_muteCancel an event
hookdeck_events_cancel_ignored_event_bulk_retryCancel an ignored events bulk retry
hookdeck_events_cancel_request_bulk_retryCancel a requests bulk retry
hookdeck_events_create_event_bulk_cancelCreate an events bulk cancel
hookdeck_events_create_event_bulk_retryCreate an events bulk retry
hookdeck_events_create_ignored_event_bulk_retryCreate an ignored events bulk retry
hookdeck_events_create_request_bulk_retryCreate a requests bulk retry
hookdeck_events_generate_event_bulk_cancel_planGenerate an events bulk cancel plan
hookdeck_events_generate_event_bulk_retry_planGenerate an events bulk retry plan
hookdeck_events_generate_ignored_event_bulk_retry_planGenerate an ignored events bulk retry plan
hookdeck_events_generate_request_bulk_retry_planGenerate a requests bulk retry plan
hookdeck_events_get_attemptGet a single attempt
hookdeck_events_get_attemptsGet attempts
hookdeck_events_get_eventGet an event
hookdeck_events_get_event_bulk_cancelGet an events bulk cancel
hookdeck_events_get_event_bulk_cancelsGet events bulk cancels
hookdeck_events_get_event_bulk_retriesGet events bulk retries
hookdeck_events_get_event_bulk_retryGet an events bulk retry
hookdeck_events_get_event_raw_bodyGet a event raw body data
hookdeck_events_get_eventsGet events
hookdeck_events_get_ignored_event_bulk_retriesGet ignored events bulk retries
hookdeck_events_get_ignored_event_bulk_retryGet an ignored events bulk retry
hookdeck_events_get_requestGet a request
hookdeck_events_get_request_bulk_retriesGet request bulk retries
hookdeck_events_get_request_bulk_retryGet a requests bulk retry
hookdeck_events_get_request_eventsGet request events
hookdeck_events_get_request_ignored_eventsGet request ignored events
hookdeck_events_get_request_raw_bodyGet a request raw body data
hookdeck_events_get_requestsGet requests
hookdeck_events_query_attempt_metricsQuery attempt metrics
hookdeck_events_query_event_metricsQuery event metrics
hookdeck_events_query_events_by_issue_metricsQuery event metrics grouped by individual issue
hookdeck_events_query_events_pending_timeseries_metricsQuery events pending timeseries metrics
hookdeck_events_query_queue_depth_metricsQuery queue depth metrics
hookdeck_events_query_request_metricsQuery request metrics
hookdeck_events_query_transformation_metricsQuery transformation execution metrics
hookdeck_events_retry_eventRetry an event
hookdeck_events_retry_requestRetry a request

hookdeck_events_cancel_event

Cancel an event Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesEvent ID

hookdeck_events_cancel_event_bulk_retry

Cancel an events bulk retry Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBulk retry ID

hookdeck_events_cancel_event_mute

Cancel an event Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesEvent ID

hookdeck_events_cancel_ignored_event_bulk_retry

Cancel an ignored events bulk retry Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBulk retry ID

hookdeck_events_cancel_request_bulk_retry

Cancel a requests bulk retry Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBulk retry ID

hookdeck_events_create_event_bulk_cancel

Create an events bulk cancel Parameters:
ParameterTypeRequiredDefaultDescription
queryobjectNoFilter properties for the events to be included in the bulk cancel

hookdeck_events_create_event_bulk_retry

Create an events bulk retry Parameters:
ParameterTypeRequiredDefaultDescription
queryobjectNoFilter 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:
ParameterTypeRequiredDefaultDescription
queryobjectNoFilter by the bulk retry ignored event query object

hookdeck_events_create_request_bulk_retry

Create a requests bulk retry Parameters:
ParameterTypeRequiredDefaultDescription
queryobjectNoFilter 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:
ParameterTypeRequiredDefaultDescription
queryobjectNoFilter 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:
ParameterTypeRequiredDefaultDescription
queryobjectNoFilter 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:
ParameterTypeRequiredDefaultDescription
queryobjectNoFilter by the bulk retry ignored event query object

hookdeck_events_generate_request_bulk_retry_plan

Generate a requests bulk retry plan Parameters:
ParameterTypeRequiredDefaultDescription
queryobjectNoFilter 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:
ParameterTypeRequiredDefaultDescription
idstringYesAttempt ID

hookdeck_events_get_attempts

Get attempts Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoID of the attempt
event_idstring[]NoEvent the attempt is associated with
order_bystring[]NoSort key(s)
dirstring[]NoSort direction(s)
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe ID to provide in the query to get the previous set of results

hookdeck_events_get_event

Get an event Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesEvent ID

hookdeck_events_get_event_bulk_cancel

Get an events bulk cancel Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBulk cancel ID

hookdeck_events_get_event_bulk_cancels

Get events bulk cancels Parameters:
ParameterTypeRequiredDefaultDescription
cancelled_atobjectNoFilter by date the bulk cancel was cancelled
completed_atobjectNoFilter by date the bulk cancel completed
created_atobjectNoFilter by date the bulk cancel was created
idstring[]NoFilter by bulk cancel IDs
queryobjectNoFilter for events to be included in the bulk cancel operation, use query parameters of Event
query_partial_matchbooleanNoAllow partial filter match on query property
in_progressbooleanNoIndicates if the bulk cancel is currently in progress
order_bystring[]NoSort key(s)
dirstring[]NoSort direction(s)
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe ID to provide in the query to get the previous set of results

hookdeck_events_get_event_bulk_retries

Get events bulk retries Parameters:
ParameterTypeRequiredDefaultDescription
cancelled_atobjectNoFilter by date the bulk retry was cancelled
completed_atobjectNoFilter by date the bulk retry completed
created_atobjectNoFilter by date the bulk retry was created
idstring[]NoFilter by bulk retry IDs
queryobjectNoFilter for events to be included in the bulk retry, use query parameters of Event
query_partial_matchbooleanNoAllow partial filter match on query property
in_progressbooleanNoIndicates if the bulk retry is currently in progress
order_bystring[]NoSort key(s)
dirstring[]NoSort direction(s)
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe 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:
ParameterTypeRequiredDefaultDescription
idstringYesBulk retry ID

hookdeck_events_get_event_raw_body

Get a event raw body data Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesEvent ID

hookdeck_events_get_events

Get events Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by event IDs
statusstring[]NoLifecyle status of the event
webhook_idstring[]NoFilter by connection (webhook) IDs
destination_idstring[]NoFilter by destination IDs
source_idstring[]NoFilter by source IDs
attemptsobjectNoFilter by number of attempts
response_statusobjectNoFilter by HTTP response status code
successful_atobjectNoFilter by successful_at date using a date operator
created_atobjectNoFilter by created_at date using a date operator
error_codestring[]NoFilter by error code code
cli_idobjectNoFilter by CLI IDs. ?[any]=true operator for any CLI.
last_attempt_atobjectNoFilter by last_attempt_at date using a date operator
next_attempt_atobjectNoFilter by next_attempt_at date using a date operator
search_termstringNoURL Encoded string of the value to match partially to the body, headers, parsed_query or path
headersobjectNoURL Encoded string of the JSON to match to the data headers
bodyobjectNoURL Encoded string of the JSON to match to the data body
parsed_queryobjectNoURL Encoded string of the JSON to match to the parsed query (JSON representation of the query)
pathstringNoURL Encoded string of the value to match partially to the path
cli_user_idstring[]NoCli User Id
issue_idstring[]NoIssue Id
event_data_idstring[]NoEvent Data Id
bulk_retry_idstring[]NoBulk Retry Id
includestringNoInclude the data object in the event model
progressivestringNoEnable progressive loading for partial results
order_bystringNoSort key
dirstringNoSort direction
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe 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:
ParameterTypeRequiredDefaultDescription
cancelled_atobjectNoFilter by date the bulk retry was cancelled
completed_atobjectNoFilter by date the bulk retry completed
created_atobjectNoFilter by date the bulk retry was created
idstring[]NoFilter by bulk retry IDs
queryobjectNoFilter by the bulk retry ignored event query object
query_partial_matchbooleanNoAllow partial filter match on query property
in_progressbooleanNoIndicates if the bulk retry is currently in progress
order_bystring[]NoSort key(s)
dirstring[]NoSort direction(s)
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe 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:
ParameterTypeRequiredDefaultDescription
idstringYesBulk retry ID

hookdeck_events_get_request

Get a request Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRequest ID

hookdeck_events_get_request_bulk_retries

Get request bulk retries Parameters:
ParameterTypeRequiredDefaultDescription
cancelled_atobjectNoFilter by date the bulk retry was cancelled
completed_atobjectNoFilter by date the bulk retry completed
created_atobjectNoFilter by date the bulk retry was created
idstring[]NoFilter by bulk retry IDs
in_progressbooleanNoIndicates if the bulk retry is currently in progress
queryobjectNoFilter properties for the events to be included in the bulk retry, use query parameters of Requests
query_partial_matchbooleanNoAllow partial filter match on query property
order_bystring[]NoSort key(s)
dirstring[]NoSort direction(s)
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe 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:
ParameterTypeRequiredDefaultDescription
idstringYesBulk retry ID

hookdeck_events_get_request_events

Get request events Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]YesFilter by event IDs
statusstring[]NoLifecyle status of the event
webhook_idstring[]NoFilter by connection (webhook) IDs
destination_idstring[]NoFilter by destination IDs
source_idstring[]NoFilter by source IDs
attemptsobjectNoFilter by number of attempts
response_statusobjectNoFilter by HTTP response status code
successful_atobjectNoFilter by successful_at date using a date operator
created_atobjectNoFilter by created_at date using a date operator
error_codestring[]NoFilter by error code code
cli_idobjectNoFilter by CLI IDs. ?[any]=true operator for any CLI.
last_attempt_atobjectNoFilter by last_attempt_at date using a date operator
next_attempt_atobjectNoFilter by next_attempt_at date using a date operator
search_termstringNoURL Encoded string of the value to match partially to the body, headers, parsed_query or path
headersobjectNoURL Encoded string of the JSON to match to the data headers
bodyobjectNoURL Encoded string of the JSON to match to the data body
parsed_queryobjectNoURL Encoded string of the JSON to match to the parsed query (JSON representation of the query)
pathstringNoURL Encoded string of the value to match partially to the path
cli_user_idstring[]NoCli User Id
issue_idstring[]NoIssue Id
event_data_idstring[]NoEvent Data Id
bulk_retry_idstring[]NoBulk Retry Id
includestringNoInclude the data object in the event model
progressivestringNoEnable progressive loading for partial results
order_bystringNoSort key
dirstringNoSort direction
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe ID to provide in the query to get the previous set of results

hookdeck_events_get_request_ignored_events

Get request ignored events Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]YesFilter by ignored events IDs
order_bystring[]NoSort key(s)
dirstring[]NoSort direction(s)
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe 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:
ParameterTypeRequiredDefaultDescription
idstringYesRequest ID

hookdeck_events_get_requests

Get requests Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by requests IDs
statusstringNoFilter by status
rejection_causestring[]NoFilter by rejection cause
source_idstring[]NoFilter by source IDs
verifiedbooleanNoFilter by verification status
search_termstringNoURL Encoded string of the value to match partially to the body, headers, parsed_query or path
headersobjectNoURL Encoded string of the JSON to match to the data headers
bodyobjectNoURL Encoded string of the JSON to match to the data body
parsed_queryobjectNoURL Encoded string of the JSON to match to the parsed query (JSON representation of the query)
pathstringNoURL Encoded string of the value to match partially to the path
ignored_countobjectNoFilter by count of ignored events
events_countobjectNoFilter by count of events
cli_events_countobjectNoFilter by count of CLI events
created_atobjectNoFilter by request created date
ingested_atobjectNoFilter by request ingested date
bulk_retry_idstring[]NoBulk Retry Id
includestringNoRelated resources to include
progressivestringNoEnable progressive loading for partial results
order_bystringNoSort key
dirstringNoSort direction
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe ID to provide in the query to get the previous set of results

hookdeck_events_query_attempt_metrics

Query attempt metrics Parameters:
ParameterTypeRequiredDefaultDescription
date_rangeobjectNoDate Range
granularitystringNoTime 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
filtersobjectNoThe filters value
measuresstring[]NoMetrics to calculate
dimensionsstring[]NoDimensions to group by

hookdeck_events_query_event_metrics

Query event metrics Parameters:
ParameterTypeRequiredDefaultDescription
date_rangeobjectNoDate Range
granularitystringNoTime 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
filtersobjectNoThe filters value
measuresstring[]NoMetrics to calculate
dimensionsstring[]NoDimensions to group by

hookdeck_events_query_events_by_issue_metrics

Query event metrics grouped by individual issue Parameters:
ParameterTypeRequiredDefaultDescription
date_rangeobjectNoDate Range
granularitystringNoTime 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
filtersobjectNoThe filters value
measuresstring[]NoMetrics to calculate
dimensionsstring[]NoDimensions to group by

hookdeck_events_query_events_pending_timeseries_metrics

Query events pending timeseries metrics Parameters:
ParameterTypeRequiredDefaultDescription
date_rangeobjectNoDate Range
granularitystringNoTime 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
filtersobjectNoThe filters value
measuresstring[]NoList of measures to aggregate (count)
dimensionsstring[]NoList of dimensions to group by

hookdeck_events_query_queue_depth_metrics

Query queue depth metrics Parameters:
ParameterTypeRequiredDefaultDescription
date_rangeobjectNoDate Range
granularitystringNoTime 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
filtersobjectNoThe filters value
measuresstring[]NoMetrics to calculate
dimensionsstring[]NoDimensions to group by

hookdeck_events_query_request_metrics

Query request metrics Parameters:
ParameterTypeRequiredDefaultDescription
date_rangeobjectNoDate Range
granularitystringNoTime 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
filtersobjectNoThe filters value
measuresstring[]NoMetrics to calculate
dimensionsstring[]NoDimensions to group by

hookdeck_events_query_transformation_metrics

Query transformation execution metrics Parameters:
ParameterTypeRequiredDefaultDescription
date_rangeobjectNoDate Range
granularitystringNoTime 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
filtersobjectNoThe filters value
measuresstring[]NoMetrics to calculate
dimensionsstring[]NoDimensions to group by

hookdeck_events_retry_event

Retry an event Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesEvent ID

hookdeck_events_retry_request

Retry a request Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRequest ID
webhook_idsstring[]NoSubset 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.