This quick start guide will get you up and running with Trigger.dev.
Create your first project
Once you’ve created an account, follow the steps in the app to:
- Complete your account details.
- Create your first Organization and Project.
Getting an API key
Go to the “Environments & API Keys” page in your project.
DEVSERVER API key.
Run the CLI `init` command
The easiest way to get started it to use the CLI. It will add Trigger.dev to your existing project, setup a route and give you an example file.
In a terminal window run:
npx @trigger.dev/cli@latest init
It will ask you a couple of questions
Run your site
Make sure your site is running locally, we will connect to it to register your Jobs.
npm run dev
Run the CLI `dev` command
dev command allows the Trigger.dev service to send messages to your site. This is required for registering Jobs, triggering them and running tasks. To achieve this it creates a tunnel (using ngrok) so Trigger.dev can send messages to your machine.
You should leave the
dev command running when you’re developing.
In a new terminal window or tab run:
npx @trigger.dev/cli@latest dev
You can optionally pass the port if you’re not running on the default port by adding
--port 3001 to the end.
Your first job
The CLI init command created a simple Job for you. There will be a new file either
In there is this Job:
If you navigate to your Trigger.dev project you will see this Job in the “Jobs” section:
Triggering the Job
There are two way to trigger this Job.
- Use the “Test” functionality in the dashboard.
- Use the Trigger.dev API (either via our SDK or a web request)
“Testing” from the dashboard
Click into the Job and then open the “Test” tab. You should see this page:
This Job doesn’t have a payload schema (meaning it takes an empty object), so you can simple click the “Run test” button.
Congratulations, you should get redirected so you can see your first Run!
Write your first Job
A Guide for how to create your first real Job
What is Trigger.dev
Learn more about how Trigger.dev works and how it can help you.
One of the quickest ways to learn how Trigger.dev works is to view some example Jobs.
Struggling getting setup or have a question? We’re here to help.