Events

Create an event

Changed on

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

post/api/v1/events

Request

  • Base URL: https://api.trigger.dev
  • URL: https://api.trigger.dev/api/v1/events
  • Auth: HTTP bearer

Request body

Response

Event successfully sent

idstring

The ID of the event that was sent.

namestring

The name of the event that was sent.

payloadDeserializedJson

A JSON object that represents the deserialized payload or context.

contextDeserializedJson

A JSON object that represents the deserialized payload or context.

timestampstring date-time

The timestamp of the event that was sent.

deliverAtstring date-time nullable

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

deliveredAtstring date-time nullable

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

cancelledAtstring date-time nullable

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

Changes

  • 0f61d649d288Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status