POST
/
api
/
v1
/
events

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
event
object
options
object

Response

200 - application/json
id
string

The ID of the event that was sent.

name
string

The name of the event that was sent.

payload
object

A JSON object that represents the deserialized payload or context.

context
object | null

The context of the event that was sent. Null if no context was set.

timestamp
string

The timestamp of the event that was sent.

deliverAt
string | null

The timestamp when the event will be delivered. Null if not applicable.

deliveredAt
string | null

The timestamp when the event was delivered. Null if not applicable.

cancelledAt
string | null

The timestamp when the event was cancelled. Null if the event wasn't cancelled.

Was this page helpful?

verifyRequestSignature()Introduction