Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hookdeck Destinations API

Manage destinations — the downstream targets (HTTP endpoints, AWS SQS, Azure Service Bus, GCP Pub/Sub, Kafka, RabbitMQ, MongoDB, and more) where Hookdeck delivers events. Supports configurable auth methods, rate limiting, path forwarding, archival, and pause/disable controls.

Hookdeck Destinations 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 Webhooks, Destinations, and Event Gateways. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

This API exposes 11 operations across 7 paths, and defines 44 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.

11 operations 7 paths 44 schemas 1 DELETE3 GET1 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.hookdeck.com/2025-07-01
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Hookdeck Destinations API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 3 GET, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Destinations 11

A destination is any endpoint to which your webhooks can be routed.

GET
/destinations
Retrieve destinations
getDestinations 10 params → 200400422
POST
/destinations
Create a destination
createDestination body → 200400422
PUT
/destinations
Create/Update a destination
upsertDestination body → 200400422
GET
/destinations/count
Count destinations
countDestinations 4 params → 200400422
GET
/destinations/{id}
Retrieve a destination
getDestination 2 params → 200404410
PUT
/destinations/{id}
Update a destination
updateDestination 1 param body → 200400404422
DELETE
/destinations/{id}
Delete a destination
deleteDestination 1 param → 200404
PUT
/destinations/{id}/disable
Disable a destination
disableDestination 1 param → 200404
PUT
/destinations/{id}/archive
Disable a destination
disableDestination_archive 1 param → 200404
PUT
/destinations/{id}/enable
Enable a destination
enableDestination 1 param → 200404
PUT
/destinations/{id}/unarchive
Enable a destination
enableDestination_unarchive 1 param → 200404

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are Destination (9 properties), DestinationTypeConfigHTTP (7 properties), DestinationTypeConfigMOCK_API (6 properties), Operators (6 properties). Each schema is shown below with its type and property counts.

DestinationPaginatedResult
object
3 properties
DestinationTypeConfigHTTP
object
The type config for HTTP. Requires type to be HTTP.
7 properties 1 required
DestinationConfigHTTPAuthBasicAuth
object
2 properties
DestinationConfigMockAPIAuthBasicAuth
object
2 properties
DestinationConfigHTTPAuthAWSSignature
object
4 properties
DestinationConfigHTTPAuthGCPServiceAccount
object
2 properties
DestinationConfigHTTPAuthOAuth2AuthorizationCode
object
5 properties
DestinationConfigMockAPIAuthBearerToken
object
1 property
DestinationConfigMockAPIAuthEmpty
DestinationConfigCLIAuthOAuth2AuthorizationCode
object
5 properties
DestinationConfigHTTPAuthAPIKey
object
3 properties
DestinationConfigHTTPAuthHookdeckSignatureDefault
object
DestinationConfigHTTPAuthBearerToken
object
1 property
DestinationConfigHTTPAuth
object
DestinationConfigHTTPAuthEmpty
DestinationConfigMockAPIAuthAWSSignature
object
4 properties
DestinationConfigCLIAuthAWSSignature
object
4 properties
DestinationConfigMockAPIAuthCustomSHA256HMACSignature
object
2 properties
APIErrorResponse
object
Error response model
4 properties 3 required
Operators
object
6 properties
OrderByDirection
DestinationTypeConfigMOCK_API
object
The type config for MOCKAPI. Requires type to be MOCKAPI.
6 properties
DestinationConfigCLIAuthBearerToken
object
1 property
DestinationConfigCLIAuthBasicAuth
object
2 properties
DestinationConfigCLIAuthAPIKey
object
3 properties
DestinationConfigMockAPIAuthOAuth2ClientCredentials
object
5 properties
VerificationConfig
object
The type configs for the specified type
DestinationConfigHTTPAuthOAuth2ClientCredentials
object
5 properties
DestinationTypeConfigCLI
object
The type config for CLI. Requires type to be CLI.
5 properties 1 required
DestinationConfigHTTPAuthCustomSHA256HMACSignature
object
2 properties
DestinationConfigMockAPIAuthHookdeckSignatureDefault
object
DestinationConfigCLIAuth
object
DestinationConfigMockAPIAuthAPIKey
object
3 properties
DestinationConfigMockAPIAuthGCPServiceAccount
object
2 properties
DestinationConfigCLIAuthCustomSHA256HMACSignature
object
2 properties
DestinationConfigCLIAuthHookdeckSignatureDefault
object
DestinationConfigMockAPIAuthOAuth2AuthorizationCode
object
5 properties
Destination
object
Associated [Destination](destination-object) object
9 properties 7 required
DestinationConfigMockAPIAuth
object
SeekPagination
object
5 properties
DestinationConfig
object
Configuration object for the destination type
DestinationConfigCLIAuthGCPServiceAccount
object
2 properties
DestinationConfigCLIAuthEmpty
DestinationConfigCLIAuthOAuth2ClientCredentials
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hookdeck-destinations-api-openapi.yml Raw ↑

Other APIs Hookdeck publishes across the network.

Hookdeck Connections API
Hookdeck Sources API
Hookdeck Events API
Hookdeck Requests API
Hookdeck Transformations API
Hookdeck Bookmarks API
Hookdeck Issues API
Hookdeck Metrics API
Hookdeck Integrations API
Hookdeck Notifications API
Hookdeck Attempts API
Hookdeck Bulk cancel events API