SVsvix
Endpoint

Send Event Type Example Message

Changed on

Send an example message for an event.

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

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example
  • Auth
    HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier
endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

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.

payloadobject nullable

Custom payload to send as an example

This is only available to allow-listed customers and should otherwise not be passed. Please contact us if you need access to this functionality

Example request

{
  "eventType": "user.signup"
}

Response

channelsstring[] nullable

List of free-form identifiers that endpoints can filter by

deliverAtstring date-time nullable
eventIdstring nullable

Optional unique identifier for the message

eventTypestring required

The event type's name

idstring required

The Message's ID.

payloadobject required
tagsstring[] nullable
timestampstring date-time required

Example response

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

Changes