Events

List event destinations

Changed on

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

Request

  • Base URL: https://api.ekho.com
  • URL: https://api.ekho.com/event-destinations
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size, 1 to 100.

Example:20
starting_afterstring

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

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

Filter to a single destination status.

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

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

  • 78c545d96a34Revision changes
    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new external_id_in_use enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new requires_ekho_review enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

    • warning

      added the new resource_not_writable enum value to the response property for the response status

  • 2a0b497bcf22Revision changes
    • warning

      added the new inventory.created enum value to the /// response property for the response status

    • warning

      added the new inventory.updated enum value to the /// response property for the response status

    • info

      added the new enum value inventory.created to the query request parameter event_type

    • info

      added the new enum value inventory.updated to the query request parameter event_type