v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Endpoint

Send Event Type Example Message

Send an example message for an event.

post/api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

eventTypestring required

The event type's name

exampleIndexinteger

If the event type schema contains an array of examples, chooses which one to send.

Defaults to the first example. Ignored if the schema doesn't contain an array of examples.

Example request

{
  "eventType": "user.signup"
}

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 Message's ID.

timestampstring date-time required

tagsstring[] nullable

deliverAtstring date-time nullable

Example response

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