Triggers

Update a trigger

Updates a trigger. Send any subset of fields; omitted fields are left unchanged. Set status to active or inactive to resume or pause the trigger.

patch/triggers/{trigger_id}

Path parameters

trigger_idstring required

Unique identifier for the trigger (prefixed with trg_).

namestring

Display name for the trigger.

descriptionstring nullable

Description of the trigger's purpose. null clears it.

statusstring

active or inactive. Setting this is how you pause and resume a trigger.

credential_idsstring[] nullable

Explicit credentials to target. Replaces the existing list wholesale.

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

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.