---
canonical_url: "https://docs.composio.dev/toolkits/trigger_dev"
markdown_url: "https://docs.composio.dev/toolkits/trigger_dev.md"
product: "platform"
version: null
last_updated: null
---

# Trigger.dev

Trigger.dev is a platform for building, deploying, and managing reliable background tasks and workflows.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `TRIGGER_DEV`
- **Version:** 00000000_00

## Tools

### Batch Trigger Task

**Slug:** `TRIGGER_DEV_BATCH_TRIGGER_TASK`

Start multiple runs of one deployed Trigger.dev task in one provider-side batch and return the batch and run IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Between 1 and 1000 runs to create; each item may include payload, context, and options. |
| `task_identifier` | string | Yes | Identifier of the deployed task to run for every item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute TRQL Query

**Slug:** `TRIGGER_DEV_EXECUTE_TRQL_QUERY`

Run one read-only Trigger.dev Query Language SELECT statement for custom run analytics and return JSON rows or CSV text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | TRQL SELECT query to execute against Trigger.dev analytics data. |
| `scope` | string ("environment" | "project" | "organization") | No | Data boundary for the query; the connected key still limits accessible data. |
| `format` | string ("json" | "csv") | No | Return typed JSON rows or CSV text. |
| `period` | string | No | Trigger.dev relative time period for the query. |
| `to_time` | string | No | End of the query time window as an ISO 8601 date-time. |
| `from_time` | string | No | Start of the query time window as an ISO 8601 date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch

**Slug:** `TRIGGER_DEV_GET_BATCH`

Retrieve a task batch's status, run IDs, completion counts, and item errors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Batch ID returned by a batch trigger; sent as batchId in the path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch Results

**Slug:** `TRIGGER_DEV_GET_BATCH_RESULTS`

Retrieve the success or failure outcome and encoded output for every run in a completed task batch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Batch ID returned by a batch trigger. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Error

**Slug:** `TRIGGER_DEV_GET_ERROR`

Retrieve one Trigger.dev error group's message, occurrence history, affected versions, and resolution or ignore state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `error_id` | string | Yes | Error-group ID returned by the error list; sent as errorId in the path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Run

**Slug:** `TRIGGER_DEV_GET_RUN`

Retrieve one run's status, timing, payload, output, attempts, metadata, relationships, schedule, and cost details. Presigned payload or output URLs are returned without fetching their content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Run ID returned by a trigger or run-list response; sent as runId in the path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Run Result

**Slug:** `TRIGGER_DEV_GET_RUN_RESULT`

Retrieve one run's compact success or failure result, including its encoded output or error and usage duration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Run ID whose terminal result is needed; sent as runId in the path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Errors

**Slug:** `TRIGGER_DEV_LIST_ERRORS`

Return one forward page of Trigger.dev error groups, optionally filtered by task, version, status, text, or time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string | No | Trigger.dev relative time period filter. |
| `search` | string | No | Text to search for in error groups. |
| `to_time` | string | No | Only include errors seen at or before this ISO 8601 date-time. |
| `statuses` | array | No | Error-group statuses to include. |
| `versions` | array | No | Deployment versions whose errors should be returned. |
| `from_time` | string | No | Only include errors seen at or after this ISO 8601 date-time. |
| `page_size` | integer | No | Number of error groups requested for this page; sent as page[size]. |
| `next_cursor` | string | No | Opaque next_cursor from a previous response. Omit for the first page; pass it back unchanged to fetch the next page. |
| `task_identifiers` | array | No | Task identifiers whose errors should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Runs

**Slug:** `TRIGGER_DEV_LIST_RUNS`

Return one forward page of runs in the connected environment, optionally filtered by time, status, task, version, tags, schedule, bulk action, test mode, or error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Run tags to match. |
| `error` | string | No | Error-group ID whose runs should be returned. |
| `is_test` | boolean | No | When set, include only test runs or only non-test runs. |
| `statuses` | array | No | Run statuses to include. |
| `versions` | array | No | Deployment versions to include. |
| `page_size` | integer | No | Number of runs requested for this page; sent as page[size]. |
| `created_to` | string | No | Only return runs created at or before this ISO 8601 date-time. |
| `next_cursor` | string | No | Opaque next_cursor from a previous response. Omit for the first page; pass it back unchanged to fetch the next page. |
| `schedule_id` | string | No | Only return runs created by this schedule. |
| `created_from` | string | No | Only return runs created at or after this ISO 8601 date-time. |
| `bulk_action_id` | string | No | Only return runs associated with this Trigger.dev bulk-action ID. |
| `created_period` | string | No | Trigger.dev relative time period for run creation. |
| `task_identifiers` | array | No | Task identifiers to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger Task

**Slug:** `TRIGGER_DEV_TRIGGER_TASK`

Start one run of a deployed Trigger.dev task and return the new run ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context` | string | No | Optional JSON-compatible context made available to the task run. |
| `options` | object | No | Optional queueing, deduplication, timing, tagging, and machine settings. |
| `payload` | string | No | JSON-compatible input payload for the task. |
| `task_identifier` | string | Yes | Identifier of the deployed task to run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |