Hookdeck Issues API
Track issues that occur on events, requests, and backpressure, and manage the triggers (rules) that open and route issues to Slack, Email, Microsoft Teams, Discord, BetterUptime, and other channels.
Hookdeck Issues API is one of 17 APIs that Hookdeck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Issues, Issue Triggers, and Observability. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.
This API exposes
5 operations
across 3 paths,
and defines 81 schemas.
It is described by OpenAPI 3.0.1, at version 1.0.0.
Requests are made against a single base URL, https://api.hookdeck.com/2025-07-01.
The identity and technical contract details declared by the specification.
RequestRejectionCause
string
AttemptStatus
string
Attempt status
DestinationConfigMockAPIAuthBearerToken
object
1 property
DestinationConfigCLIAuthAWSSignature
object
4 properties
RequestIssueWithData
object
Request issue
16 properties
11 required
DestinationConfigCLIAuth
object
IssueCount
object
1 property
1 required
EventAttempt
object
20 properties
7 required
RequestIssue
object
Request issue
15 properties
11 required
IssueStatus
string
Issue status
TransformationIssueReference
object
Reference to the event request transformation an issue is being created for.
2 properties
1 required
TransformationExecution
object
13 properties
9 required
ShortEventData
object
Request data
6 properties
5 required
TransformationIssueData
object
Transformation issue data
2 properties
1 required
DestinationConfigCLIAuthEmpty
RequestIssueAggregationKeys
object
Keys used as the aggregation keys a 'request' type issue
2 properties
2 required
DestinationTypeConfigHTTP
object
The type config for HTTP. Requires type to be HTTP.
7 properties
1 required
DestinationConfigCLIAuthOAuth2AuthorizationCode
object
5 properties
DestinationConfigMockAPIAuthEmpty
DeliveryIssueWithData
object
Delivery issue
16 properties
11 required
DestinationConfigHTTPAuthEmpty
DestinationConfigMockAPIAuthAWSSignature
object
4 properties
Event
object
18 properties
15 required
Operators
object
6 properties
DestinationConfigCLIAuthAPIKey
object
3 properties
BackpressureIssueWithData
object
Backpressure issue
16 properties
11 required
DestinationConfigHTTPAuthCustomSHA256HMACSignature
object
2 properties
DestinationConfigMockAPIAuthAPIKey
object
3 properties
DestinationConfigCLIAuthHookdeckSignatureDefault
object
Destination
object
Associated [Destination](destination-object) object
9 properties
7 required
SeekPagination
object
5 properties
AttemptTrigger
string
How the attempt was triggered
DeliveryIssue
object
Delivery issue
15 properties
11 required
TransformationIssueAggregationKeys
object
Keys used as the aggregation keys a 'transformation' type issue
2 properties
2 required
RequestIssueReference
object
Reference to the request an issue is being created for.
1 property
1 required
IssueWithDataPaginatedResult
object
3 properties
RequestIssueData
object
Request issue data
1 property
DestinationConfigHTTPAuthGCPServiceAccount
object
2 properties
DestinationConfigHTTPAuthOAuth2AuthorizationCode
object
5 properties
AttemptErrorCodes
string
Error code of the delivery attempt
DestinationConfigHTTPAuthBearerToken
object
1 property
DestinationConfigHTTPAuth
object
IssueTriggerBackpressureDelay
integer
The minimum delay (backpressure) to open the issue for min of 1 minute (60000) and max of 1 day (86400000)
APIErrorResponse
object
Error response model
4 properties
3 required
DestinationConfigCLIAuthBasicAuth
object
2 properties
DestinationConfigMockAPIAuthOAuth2ClientCredentials
object
5 properties
DestinationConfigHTTPAuthOAuth2ClientCredentials
object
5 properties
DestinationTypeConfigCLI
object
The type config for CLI. Requires type to be CLI.
5 properties
1 required
DeliveryIssueReference
object
Reference to the event and attempt an issue is being created for.
2 properties
2 required
DestinationConfigMockAPIAuthHookdeckSignatureDefault
object
EventData
object
Event data if included
9 properties
7 required
TransformationExecutionLogLevel
string
The minimum log level to open the issue on
DestinationConfigMockAPIAuthGCPServiceAccount
object
2 properties
DestinationConfigMockAPIAuthOAuth2AuthorizationCode
object
5 properties
BackpressureIssueReference
object
Reference to the destination backpressure an issue is being created for.
1 property
1 required
DestinationConfigMockAPIAuth
object
DeliveryIssueAggregationKeys
object
Keys used as the aggregation keys a 'delivery' type issue
3 properties
3 required
BackpressureIssueData
object
Backpressure issue data
1 property
DestinationConfigCLIAuthGCPServiceAccount
object
2 properties
ConsoleLine
object
2 properties
2 required
DestinationConfigCLIAuthOAuth2ClientCredentials
object
5 properties
BackpressureIssueAggregationKeys
object
Keys used as the aggregation keys a 'backpressure' type issue
2 properties
2 required
DestinationConfigHTTPAuthBasicAuth
object
2 properties
DestinationConfigMockAPIAuthBasicAuth
object
2 properties
Request
object
13 properties
12 required
DestinationConfigHTTPAuthAWSSignature
object
4 properties
DestinationConfigHTTPAuthAPIKey
object
3 properties
DestinationConfigHTTPAuthHookdeckSignatureDefault
object
TransformationIssue
object
Transformation issue
15 properties
11 required
DestinationConfigMockAPIAuthCustomSHA256HMACSignature
object
2 properties
BackpressureIssue
object
Backpressure issue
15 properties
11 required
DestinationTypeConfigMOCK_API
object
The type config for MOCKAPI. Requires type to be MOCKAPI.
6 properties
DestinationConfigCLIAuthBearerToken
object
1 property
TransformationIssueWithData
object
Transformation issue
16 properties
11 required
DestinationConfigCLIAuthCustomSHA256HMACSignature
object
2 properties
DeliveryIssueData
object
Delivery issue data
2 properties
DestinationConfig
object
Configuration object for the destination type
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Hookdeck publishes across the network.
