Function | Where does this work? | What it does |
---|---|---|
yourTask.trigger() | Anywhere | Triggers a task and gets a handle you can use to monitor and manage the run. It does not wait for the result. |
yourTask.batchTrigger() | Anywhere | Triggers a task multiple times and gets a handle you can use to monitor and manage the runs. It does not wait for the results. |
yourTask.triggerAndWait() | Inside a task | Triggers a task and then waits until it’s complete. You get the result data to continue with. |
yourTask.batchTriggerAndWait() | Inside a task | Triggers a task multiple times in parallel and then waits until they’re all complete. You get the resulting data to continue with. |
From outside of a task
You can trigger any task from your backend code, using eithertrigger()
or batchTrigger()
.
Do not trigger tasks directly from your frontend. If you do, you will leak your private
Trigger.dev API key to the world.
Authentication
When you trigger a task from your backend code, you need to set theTRIGGER_SECRET_KEY
environment variable. You can find the value on the API keys page in the Trigger.dev dashboard. More info on API keys.
trigger()
Triggers a single run of a task with the payload you pass in, and any options you specify. It does NOT wait for the result, you cannot do that from outside a task.batchTrigger()
Triggers multiples runs of a task with the payloads you pass in, and any options you specify. It does NOT wait for the results, you cannot do that from outside a task.From inside a task
You can trigger tasks from other tasks usingtrigger()
or batchTrigger()
. You can also trigger and wait for the result of triggered tasks using triggerAndWait()
and batchTriggerAndWait()
. This is a powerful way to build complex tasks.
trigger()
This works the same as from outside a task. You call it and you get a handle back, but it does not wait for the result./trigger/my-task.ts
batchTrigger()
This works the same as from outside a task. You call it and you get a handle back, but it does not wait for the results./trigger/my-task.ts
triggerAndWait()
This is where it gets interesting. You can trigger a task and then wait for the result. This is useful when you need to call a different task and then use the result to continue with your task./trigger/parent.ts
batchTriggerAndWait()
You can batch trigger a task and wait for all the results. This is useful for the fan-out pattern, where you need to call a task multiple times and then wait for all the results to continue with your task./trigger/nested.ts
Next.js Server Actions
Server Actions allow you to call your backend code without creating API routes. This is very useful for triggering tasks but you need to be careful you don’t accidentally bundle the Trigger.dev SDK into your frontend code. If you see an error like this then you’ve bundled@trigger.dev/sdk
into your frontend code:
@trigger.dev/sdk
:
- The file can’t have any React components in it.
- The file should have
"use server"
on the first line.