v1

latestOpenAPI 3.0.02026-07-2641142112.7 KB

Endpoint

Send Event Type Example Message

Send an example message for a specific event. Note that this will only sent demo data (and not real tracking data) This can only be used to send event types that are configured for the endpoint.

post/endpoint/{endpoint_id}/send-example

Path parameters

endpoint_idstring required

The ep's ID or UID To retrieve your endpoints ids, use GET /endpoint.

Example:unique-ep-identifier

The ep's ID or UID

Headers

idempotency-keystring

The request's idempotency key

Request body

eventTypestring required

The event type's name

Response

eventIdstring nullable

Optional unique identifier for the message

eventTypestring required

The event type's name

payloadobject required

channelsstring[] nullable

List of free-form identifiers that endpoints can filter by

idstring required

The msg's ID

timestampstring date-time required

Example response

{
  "eventId": "unique-msg-identifier",
  "payload": {
    "email": "test@example.com",
    "type": "user.created",
    "username": "test_user"
  },
  "channels": [
    "project_123",
    "group_2"
  ],
  "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2"
}