Get Livechat Trigger

Get
/api/v1/livechat/triggers/{_id}

Get the details about a specific trigger. Permission required: view-livechat-manager

Changelog

Version Description
2.2.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
_id
stringRequired

The trigger ID.

ExampleLk52shJFYyb55trw8
Responses
200

OK

Success Example
{
  "trigger": {
    "_id": "Lk52shJFYyb55trw8",
    "name": "test",
    "description": "test",
    "enabled": true,
    "runOnce": true,
    "conditions": [
      {
        "name": "page-url",
        "value": ""
      }
    ],
    "actions": [
      {
        "name": "send-message",
        "params": {
          "sender": "",
          "msg": ""
        }
      }
    ],
    "_updatedAt": "2019-10-04T15:36:29.695Z"
  },
  "success": true
}
Expand All
object
trigger
object
_id
string
name
string
description
string
enabled
boolean
runOnce
boolean
conditions
Array of object
object
name
string
value
string
actions
Array of object
object
name
string
params
object
sender
string
msg
string
_updatedAt
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string