Roadmap

Integrations

Community

Templates

Trigger.dev

Login

Sign up

Welcome

Trigger.dev Documentation

What is Trigger.dev

What is Trigger.dev?

Get your first workflow running in just a few minutes

Quick Start

Getting started with Trigger.dev

Example workflows to use in your projects.

Examples

Example workflows

Webhooks allow you to subscribe to events from APIs you use.

Webhooks

Custom event triggers allow you to run workflows from your own code (or your other workflows)

Custom events

Custom event triggers

Scheduled (CRON)

Scheduled triggers

A generic fetch function that can be used to call any HTTP endpoint

Fetch

Generic Fetch

There are 4 different types of logs you can add as workflow steps.

Logging

You can trigger workflow steps to fire before and after a delay. There are 2 types of delay, waitFor and waitUntil.

Delays

Send events to trigger your custom events workflows.

Send event

Perform an action only once per run, even if your server is restarted.

Run Once

Loops, Conditionals…

Learn how to use our integrations to easily work with 3rd party APIs.

Using integrations

Learn how to use environments and API keys

Environments & API Keys

Environments and API Keys

Learn how to test your workflows from app.trigger.dev

Testing workflows

Learn how to deploy your workflows to a production environment.

Deployment

Deploying your Workflows

Understand how keys work to ensure resumability of long-running workflows in Trigger.dev

Keys and Resumability

Resumability

Event filters are used to filter events based on their attributes.

Event Filters

TypeScript-first schema validation with static type inference

Zod Guide

The Trigger class let's you define a workflow that is triggered by a specific event.

new Trigger()

Trigger

Trigger a workflow when a custom event is received.

customEvent

customEvent Trigger

Trigger a workflow when a webhook event is received

webhookEvent

webhookEvent Trigger

scheduleEvent

scheduleEvent Trigger

Send a custom event to Trigger, from inside or outside of a workflow.

sendEvent

Send a custom event to Trigger through the API.

Send Event

Contact us if you have any questions, or would like help with any issues.

Get help

Get in touch with us!

This section is aimed at collecting common questions users have to provide documented answers.

We release features and fixes weekly! See some of the changes we have made.

Changelog

Post Message

Post a Slack message in response to a user interaction in Slack

Post Message Response

Add Reaction

Open a view for a user, usually in response to a user action.

Open View

Trigger a workflow when a user interacts with a BlockKit interaction component (e.g. buttons, menus, etc.)

Block Actions

Trigger a workflow when a user submits a modal view.

View Submission

Trigger a workflow whenever an issue_comment action is performed in a GitHub repository.

Issue Comments

Issue Comment Event

Trigger a workflow whenever an issue action is performed in a GitHub repository.

Issues

Issue Event

Trigger a workflow whenever a user star's the specified GitHub repository.

New Star

New Star Event

Trigger a workflow whenever an pull_request_review_comment action is performed in a GitHub repository.

PR Review Comments

PR Review Comment Event

Trigger a workflow whenever an pull_request_review action is performed in a GitHub repository.

PR Reviews

PR Review Event

Trigger a workflow whenever an pull_request action is performed in a GitHub repository.

Pull Requests

Pull Request Event

Trigger a workflow whenever a push action is performed in a GitHub repository.

Pushes

Push Event

Get a user's information

Returns a paginated list of Users for the workspace. The response may contain fewer than page_size of results.

List users

Get bot info

Retrieves a Page object using the ID specified.

Get a page

Update a page icon, cover or archived status. You can update a database page's properties but the properties must match the parent database schema.

Update a page

Creates a new page that is a child of an existing page or database. If the parent is a page then `title` is the only valid property. If the parent is a database then the `properties` must match the parent database's properties.

Create a page

Retrieves a Block object using the ID specified. If a block contains the key has_children: true, use the Retrieve block children endpoint to get the list of children

Get a block

Update a block Updates the content for the specified block_id based on the block type. Supported fields based on the block object type.

Update a block

Returns a paginated array of child block objects contained in the block using the ID specified. In order to receive a complete representation of a block, you may need to recursively retrieve the block children of child blocks.

Get block children

Sets a Block object, including page blocks, to archived: true using the ID specified.

Delete a block

Creates and appends new children blocks to the parent block_id specified. Returns a paginated list of newly created first level children block objects.

Append blocks

Append block

Retrieves a Database object using the ID specified.

Get a database

Gets a list of Pages contained in the database, filtered and ordered according to the filter conditions and sort criteria provided in the request. The response may contain fewer than page_size of results.

Query a database

Creates a database as a subpage in the specified parent page, with the specified properties schema.

Create a database

Update the title, description, or properties of a specified database. Sending a request with a properties body param changes the columns of a database. To update a row rather than a column, query the Update page endpoint. To add a new row to a database, call Create a page.

Update a database

Creates a comment in a page or existing discussion thread.

Create a comment

Retrieves a list of un-resolved Comment objects from a page or block.

Get comments

Searches all original pages, databases, and child pages/databases that are shared with the integration. It will not return linked databases, since these duplicate their source databases.

Search

Text Message

Send Text Message

Reaction Message

Send a Reaction Message

Audio Message

Send Audio Message

Video Message

Send Video Message

Document Message

Send Document Message

Sticker Message

Send a Sticker Message

Template Message

Send Template Message

Location Message

Send a Location Message

Contacts Message

Send a Contacts Message

Trigger a workflow whenever a WhatsApp message is received in your WhatsApp Business Account

Message

Message Event

Send Email

List records in a table. Note that table names and table ids can be used interchangeably. We recommend using table IDs so you don't need to modify your API request when your table name changes.
The server returns one page of records at a time. Each page will contain pageSize records, which is 100 by default. If there are more records, the response will contain an offset. To fetch the next page of records, include offset in the next request's parameters. Pagination will stop when you've reached the end of your table. If the maxRecords parameter is passed, pagination will stop once you've reached this maximum.
Returned records do not include any fields with "empty" values, e.g. "", [], or false.

List Records

Retrieve a single record. Any "empty" fields (e.g. "", [], or false) in the record will not be returned.

Get Record

Create Records

Update Record

Updates up to 10 records, or upserts them when performUpsert is set.

Update Records

Delete Record

Delete more than one records with the given record IDs. Note you can't delete a single record with this.

Delete Records

Send email to one or more recipients with personalization

Mail Send

Add or update (up to 30k) contacts. Contacts are queued and aren't created immediately.

Roadmap

Next up

Integrations

Features

Platform

​Next up

​Integrations

​Features

​Platform

Next up

Integrations

Features

Platform