v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-102991198.1 KB
Destinations

List Destinations

Return a list of the destinations for the tenant. The endpoint is not paged.

get/tenants/{tenant_id}/destinations

Query parameters

'webhook' | 'aws_sqs' | 'rabbitmq' | 'hookdeck' | 'aws_kinesis' | 'azure_servicebus' | 'aws_s3' | 'gcp_pubsub'

Type of destination.

OR
DestinationType[]
Example:webhook

Filter destinations by type(s). Use bracket notation for multiple values (e.g., type[0]=webhook&type[1]=aws_sqs).

string
OR
string[]

Filter destinations by supported topic(s). Use bracket notation for multiple values (e.g., topics[0]=user.created&topics[1]=user.deleted).

Response

A list of destinations.

Example response

[
  {
    "id": "des_webhook_123",
    "type": "webhook",
    "topics": [
      "user.created",
      "order.shipped"
    ],
    "disabled_at": null,
    "created_at": "2024-02-15T10:00:00Z",
    "updated_at": "2024-02-15T10:00:00Z",
    "config": {
      "url": "https://my-service.com/webhook/handler"
    },
    "credentials": {
      "secret": "whsec_abc123def456",
      "previous_secret": "whsec_prev789xyz012",
      "previous_secret_invalid_at": "2024-02-16T10:00:00Z"
    }
  }
]