TriggerClient is used to create a client that connects to the Trigger.dev platform
TriggerClient
should only ever be used in a server-side environment. It is not safe to use
in a browser environment because it exposes your API Key.run()
function.
run()
function.
getEvent()
method gets the event details for a given eventId.
cancelEvent()
method cancels an event that is scheduled to be delivered in the future.
cancelRunsForEvent()
method cancels the job runs (yet to be executed) that are triggered by a given eventId.
cancelRunsForJob()
method cancels all runs for the specified job (yet to be executed).
getRuns()
method gets runs for a Job.
getRun()
method gets the details for a given Run.
defineJob()
method defines a new Job.
defineHttpEndpoint()
method defines a new HTTP Endpoint.
defineDynamicTrigger()
method defines a new Dynamic Trigger.
defineDynamicSchedule()
method defines a new Dynamic Schedule.
defineAuthResolver()
method defines a new Auth Resolver.
on()
method to listen for run notifications across all Jobs.