Skip to main content
PATCH
/
event-destinations
/
{destination_id}
Update an event destination
curl --request PATCH \
  --url https://api.deck.co/v2/event-destinations/{destination_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "status": "<string>",
  "events": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status": "<string>",
  "type": "<string>",
  "events": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "request_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

​
destination_id
string
required

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

Body

Request body for updating an event destination. Only include fields you want to change.

​
name
null | string

Updated display name.

​
status
null | string

Updated status: active or inactive.

​
events
null | string[]

Updated list of subscribed event types.

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_.

​
name
string
required

Display name for the event destination.

​
status
string
required

Destination status: pending_verification, active, or inactive.

​
type
string
required

Destination type. One of webhook, aws_sqs, aws_kinesis, aws_s3, aws_eventbridge, gcp_pubsub, rabbitmq, azure_servicebus, or 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.

​
object
null | string

Always event_destination.

​
request_id
null | string

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