Events

Create an event destination

Changed on

Registers an event destination bound to the token's account. List every subscribable event type the URL should receive on event_types; one destination can carry as many as you like, so a URL needs only one signing secret and your handler branches on the envelope's type. Register a second destination to deliver to a different URL, not to separate one event type from another. The secret is returned once, in this response. The target is validated as an https URL and screened by the delivery-time SSRF guard before it is stored. The api_version is pinned from the resolved Ekho-Version, and the creation channel is inferred from the User-Agent (Zapier clients record zapier, everything else api).

post/event-destinations

Request

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

Request body

urlstring uri required

The https target URL that receives event deliveries.

event_typesstring[] required

Every event type this destination receives. One destination can carry as many types as you like, so a single URL needs only one signing secret. Read the envelope's type field to tell deliveries apart. Duplicates are collapsed.

display_namestring

Optional human-friendly label for the destination.

descriptionstring

Optional longer description of the destination.

Example request

{
  "url": "https://example.com/webhooks/preorder",
  "event_types": [
    "order.vehicle.placed",
    "order.vehicle.updated"
  ]
}

Response

The event destination was created.

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 inventory.created enum value to the request property /

    • info

      added the new inventory.updated enum value to the request property /