Skip to main content
GET
/
event-destinations
/
{destination_id}
Retrieve an event destination
curl --request GET \
  --url https://api.deck.co/v2/event-destinations/{destination_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "status": "<string>",
  "events": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "request_id": "<string>",
  "webhook": {
    "url": "<string>"
  },
  "aws_sqs": {
    "queue_url": "<string>"
  },
  "aws_kinesis": {
    "stream_name": "<string>",
    "region": "<string>"
  },
  "aws_s3": {
    "bucket": "<string>",
    "region": "<string>"
  },
  "aws_eventbridge": {
    "event_bus_name": "<string>",
    "region": "<string>"
  },
  "gcp_pubsub": {
    "project_id": "<string>",
    "topic": "<string>"
  },
  "rabbitmq": {
    "exchange": "<string>",
    "server_url": "<string>"
  },
  "azure_servicebus": {
    "name": "<string>"
  },
  "hookdeck": {}
}

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

destination_id
string
required

Unique identifier for the event destination (prefixed with evtd_).

Response

OK

An event destination object representing an endpoint that receives platform events.

id
string
required

Unique identifier for the event destination, prefixed with evtd_.

object
string
required

Always event_destination.

name
string
required

Display name for the event destination.

status
string
required

Destination status: pending_verification, active, or inactive.

type
enum<string>
required

Destination type. The endpoint configuration is returned under a property whose name equals this value (for example, a webhook destination returns a webhook object).

Available options:
webhook,
aws_sqs,
aws_kinesis,
aws_s3,
aws_eventbridge,
gcp_pubsub,
rabbitmq,
azure_servicebus,
hookdeck
events
string[]
required

Event types this destination is subscribed to.

created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created.

updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

request_id
null | string

Unique identifier for the API request. Include this when contacting support.

webhook
object

Configuration returned for a webhook destination (credentials are never returned).

aws_sqs
object

Configuration returned for a aws_sqs destination (credentials are never returned).

aws_kinesis
object

Configuration returned for a aws_kinesis destination (credentials are never returned).

aws_s3
object

Configuration returned for a aws_s3 destination (credentials are never returned).

aws_eventbridge
object

Configuration returned for a aws_eventbridge destination (credentials are never returned).

gcp_pubsub
object

Configuration returned for a gcp_pubsub destination (credentials are never returned).

rabbitmq
object

Configuration returned for a rabbitmq destination (credentials are never returned).

azure_servicebus
object

Configuration returned for a azure_servicebus destination (credentials are never returned).

hookdeck
object

Configuration returned for a hookdeck destination (credentials are never returned).