Sign in
Events

List event destinations

Returns a cursor-paginated list of the account's event destinations, newest first. Filter by status, or by event_type to return every destination whose event_types include that one. Deleted destinations are excluded.

get/event-destinations

Query parameters

limitinteger

Page size, 1 to 100.

Example:20

Page size, 1 to 100.

starting_afterstring

Return the page after this resource id (newest first).

Return the page after this resource id (newest first).

status'enabled' | 'disabled' | 'auto_disabled'

Filter to a single destination status.

Filter to a single destination status.

event_type'preorder.placed' | 'preorder.updated' | 'lead.created' | 'lead.updated' | 'order.vehicle.placed' | 'order.vehicle.updated'

Filter to destinations whose event_types include this one.

Filter to destinations whose event_types include this one.

Response

A page of event destinations.

has_moreboolean required

True when another page follows the returned one.

next_cursorstring nullable required

Pass as starting_after to fetch the next page; null when has_more is false.

Example response

{
  "data": [
    {
      "id": "whe_a1b2c3d4e5f6",
      "api_version": "v1",
      "secret": "whsec_4f1d…"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.