Overview

A TriggerClient is used to connect to a specific Project by using an API Key.

export const client = new TriggerClient({
  id: "my-webapp",
  apiKey: process.env.TRIGGER_API_KEY!,
});

​

Constructor

​

TriggerClient()

Creates a new TriggerClient object.

​

Instance properties

​

Instance methods

​

sendEvent()

Sending an event triggers any Jobs that are listening for that event (based on the name). Use eventTrigger() on a Job to listen for events.

You can call this function from anywhere in your code to send an event. The other way to send an event is by using io.sendEvent() from inside a run() function.

​

getEvent()

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

​

cancelEvent()

The cancelEvent() method cancels an event that is scheduled to be delivered in the future.

​

getRuns()

The getRuns() method gets runs for a Job.

​

getRun()

The getRun() method gets the details for a given Run.

​

defineJob()

The defineJob() method defines a new Job.

​

defineDynamicTrigger()

The defineDynamicTrigger() method defines a new Dynamic Trigger.

​

defineDynamicSchedule()

The defineDynamicSchedule() method defines a new Dynamic Schedule.

​

defineAuthResolver()

The defineAuthResolver() method defines a new Auth Resolver.