PUT /api/v2/triggers/{trigger_id}

Allowed For

Note

Updating a condition or action updates both the conditions and actions arrays, clearing all existing values of both arrays. Include all your conditions and actions when updating any condition or action.

Servers

Path parameters

Name Type Required Description
trigger_id Integer Yes

The ID of the trigger

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
trigger Object No
trigger.any[] Array No

Legacy format for conditions (deprecated). Use conditions.any instead

trigger.any[].field String No
trigger.any[].operator String No
trigger.any[].value No
trigger.description String No

The description of the ticket trigger

trigger.default Boolean No

If true, the ticket trigger is a standard trigger

trigger.url String No

The url of the ticket trigger

trigger.conditions Object No

An object that describes the circumstances under which the trigger performs its actions. See Conditions reference

trigger.conditions.any[] Array No
trigger.conditions.any[].field String No
trigger.conditions.any[].operator String No
trigger.conditions.any[].value No
trigger.conditions.all[] Array No
trigger.conditions.all[].field String No
trigger.conditions.all[].operator String No
trigger.conditions.all[].value No
trigger.position Integer No

Position of the ticket trigger, determines the order they will execute in

trigger.updated_at String No

The time of the last update of the ticket trigger

trigger.id Integer No

Automatically assigned when created

trigger.category Object No

A category to create and assign to the trigger

trigger.category.name String No
trigger.category.position Integer No
trigger.actions[] Array Yes

An array of actions describing what the ticket trigger will do. See Actions reference

trigger.actions[].field String No
trigger.actions[].value No
trigger.active Boolean No

Whether the ticket trigger is active

trigger.brand_id Integer No

The ID of the brand the ticket trigger belongs to

trigger.restriction Object No

Access restriction for this trigger. A null value allows unrestricted access

trigger.all[] Array No

Legacy format for conditions (deprecated). Use conditions.all instead

trigger.all[].field String No
trigger.all[].operator String No
trigger.all[].value No
trigger.raw_title String No

The raw format of the title of the ticket trigger

trigger.category_id String No

The ID of the category the ticket trigger belongs to

trigger.title String Yes

The title of the ticket trigger

trigger.created_at String No

The time the ticket trigger was created

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.