SDK: Introduction

The SDK is how you interact with Trigger.dev

These are the docs for Trigger.dev v2 which will be deprecated on January 31st, 2025. You probably want the v3 docs.

The SDK requires Node.js v18 or above

Name	Description
TriggerClient	TriggerClient is used to create a client that connects to the Trigger.dev platform
Job	Create, configure and run a Job
IO	The second parameter in a Job’s run() function. It holds Integrations and useful actions you can perform.
context	The third parameter in a Job’s run() function. An object that contains information about the Organization, Job, Run and more.
eventTrigger()	eventTrigger() is set as a Job’s trigger to subscribe to an event a Job from a sent event.
cronTrigger()	cronTrigger() is set as a Job’s trigger to trigger a Job on a recurring schedule using a CRON expression.
intervalTrigger()	intervalTrigger() is set as a Job’s trigger to trigger a Job at a recurring interval.
DynamicTrigger	DynamicTrigger allows you to define a trigger that can be configured dynamically at runtime.
DynamicSchedule	DynamicSchedule allows you to define a scheduled trigger that can be configured dynamically at runtime.
isTriggerError	Use this function if you’re using a try/catch block to catch errors.
redactString	An easy way to redact sensitive information from a string