TriggerClient: getEvent() instance method

The getEvent() method gets the event details for a given eventId.

Parameters

eventId · string · required

The event ID to get the details for. This is returned when calling either client.sendEvent() or io.sendEvent().

Returns

id · string | undefined

The event ID.

name · string | undefined

The event name.

createdAt · Date | undefined

When the event was created

updatedAt · Date | undefined

When the event was last updated

runs · Run[] | undefined

Show Run

id · string | undefined

The id of the run

status · RunStatus | undefined

The status of the run. Can be one of the following: PENDING, CANCELED, SUCCESS, QUEUED, WAITING_ON_CONNECTIONS, PREPROCESSING, STARTED, FAILURE, TIMED_OUT, ABORTED

startedAt · Date | undefined

The time the run started

completedAt · Date | undefined

The time the run completed

getEvent example

const event = await client.getEvent(anEventId);
if (event.runs.length === 0) {
  throw new Error("No runs");
}