Triggers

Create a trigger

Creates a trigger that runs a task on a schedule across a set of credentials. The trigger is created active and fires on its schedule immediately.

post/triggers

Request body

namestring required

Display name for the trigger.

descriptionstring nullable

Description of the trigger's purpose.

task_idstring required

The task to run. Prefixed with task_. Cannot be changed after creation.

credential_idsstring[] nullable

Explicit credentials to target, one or many. Pass exactly one of credential_ids / credential_filter.

{"stackTrail":"components:schemas:JsonElement","oasType":"schema","type":"unknown","description":"Arbitrary JSON value."}

Created

idstring required

Unique identifier for the trigger, prefixed with trg_.

objectstring required

Always trigger.

namestring required

Display name for the trigger.

descriptionstring nullable required

Description of the trigger's purpose.

statusstring required

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

task_idstring required

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

credential_idsstring[] nullable required

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

{"stackTrail":"components:schemas:JsonElement","oasType":"schema","type":"unknown","description":"Arbitrary JSON value."}

created_atstring date-time required

ISO 8601 timestamp of when the resource was created.

updated_atstring date-time required

ISO 8601 timestamp of when the resource was last updated.

request_idstring required

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

No recorded changes to this endpoint across all 1 revision of this API.