Create an event

Send an event to Trigger.dev to trigger job runs through eventTrigger()

Authorizations

Authorization

string

header

required

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

Body

application/json

event

object

Show child attributes

event.name

string

required

The name of the event

event.payload

object

The payload of the event

event.context

object

An optional context object

event.id

string

Unique identifier for the event. Auto-generated if not provided. If you provide an ID that already exists, the event will not be redelivered.

event.timestamp

string

Event timestamp. Defaults to current timestamp if not provided.

event.source

string

Event source, default is 'trigger.dev'.

options

object

Show child attributes

options.deliverAt

string

Optional Date to deliver the event.

options.deliverAfter

integer

Optional delay in seconds before delivering the event.

options.accountId

string

Optional account ID to associate with the event.

Response

200

application/json

Event successfully sent

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

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.