Sign in
Event Destinations

Create an event destination

Creates a new event destination (e.g. a webhook endpoint) to receive platform events.

post/event-destinations

Request body

namestring required

Display name for the event destination.

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

Destination type. Defaults to webhook if omitted. Send the matching configuration object under a property whose name equals this value (for example, when type is aws_sqs, include an aws_sqs object).

eventsstring[] nullable

Event types to subscribe to (for example task_run.completed, credential.verified). Use ["*"] to subscribe to all event types; * cannot be combined with specific types, and the list must not be empty.

Response

Created

idstring required

Unique identifier for the event destination, prefixed with evtd_.

objectstring required

Always event_destination.

namestring required

Display name for the event destination.

statusstring required

Destination status: pending_verification, active, or inactive.

type'webhook' | 'aws_sqs' | 'aws_kinesis' | 'aws_s3' | 'aws_eventbridge' | 'gcp_pubsub' | 'rabbitmq' | 'azure_servicebus' | 'hookdeck' 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).

eventsstring[] required

Event types this destination is subscribed to.

created_atstring date-time required

ISO 8601 timestamp of when the resource was created.

updated_atstring date-time required

ISO 8601 timestamp of when the resource was last updated.

request_idstring nullable

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

hookdeckobject

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

Changes