Skip to main content
GET
Retrieve a trigger

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

trigger_id
string
required

Unique identifier for the trigger (prefixed with trg_).

Response

OK

A trigger object. Triggers create task runs on a schedule across a set of credentials.

id
string
required

Unique identifier for the trigger, prefixed with trg_.

object
string
required

Always trigger.

name
string
required

Display name for the trigger.

description
null | string
required

Description of the trigger's purpose.

status
string
required

active or inactive. Inactive triggers keep their configuration and fire nothing.

condition
object
required

When the trigger fires: a cron expression evaluated in a timezone.

task_id
string
required

The task this trigger runs. Prefixed with task_. Fixed at creation.

credential_ids
null | string[]
required

Explicit credentials the trigger targets. null when the trigger uses credential_filter.

credential_filter
null | object
required

Credential scope the trigger fans out across. null when the trigger uses credential_ids.

input
null | any
required

Input passed to every run this trigger creates, matching the task's input_schema.

skip_if
null | object
required

Skip condition evaluated per credential before a run is created.

concurrency_max
required

Maximum simultaneous runs from this trigger. null means no per-trigger cap.

created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created.

updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

request_id
string
required

Unique identifier for the API request. Include this when contacting support.