POST/desk/api/v2/triggers.json

Create a new trigger.

Body Params

Trigger is an action that can be taken on one or more tickets based on specific criteria.

    • Name
      addToNewInboxes
      Type
      boolean
      Description
      AddToNewInboxes is true if the trigger is applied to all current and future inboxes
    • Name
      agentHasAccess
      Type
      boolean
      Description
      AgentHasAccess will be true if the creator of the trigger has granted access to agents.
    • Name
      conditions
      Type
      array
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      deletedAt
      Type
      string
      Description
      DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
    • Name
      deletedBy
      Type
      object
    • Name
      description
      Type
      string
      Description
      Description provides context of why this trigger is created
    • Name
      filter_args
      Type
      object
      Description
      RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
    • Name
      id
      Type
      integer
    • Name
      inboxes
      Type
      array
    • Name
      isShared
      Type
      boolean
      Description
      IsShared is true if the trigger is shared among all users.
    • Name
      isSystem
      Type
      boolean
      Description
      IsSystem is used to determine if a trigger was created by the system or the user If a trigger is created by the system, it cannot be deleted or modified by the user, only enabled/disabled
    • Name
      name
      Type
      string
      Description
      Trigger name is shown in ticket meta data when a ticket has been actioned by this specific trigger
    • Name
      state
      Type
      string
      Description
      State handles marking a trigger as active, inactive, incomplete as well as deleted. When triggers are active they can be deleted through the `DELETE` endpoint. Triggers can be marked active, inactive, and incomplete through `PATCH`. Deleted triggers cannot be modified via `PATCH`.
    • Name
      tickets
      Type
      array
    • Name
      triggeractions
      Type
      array
    • Name
      type
      Type
      string
      Description
      Type is the trigger type.
    • Name
      updatedAt
      Type
      string
      Description
      UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
    • Name
      updatedBy
      Type
      object

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      TriggerAPIBody is the request/response format for the API
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    201 Created

    TriggerAPIBody
    {  "applyToExistingTickets": true,  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",        "id": 0,        "postalCode": "string",        "secondLine": "string",        "state": "string"      }    ],    "agentsnotified": [      {        "autoFollowOnCC": true,        "avatarURL": "string",
    Download Swagger