Trigger

List all trigger endpoint

Get the detail of the trigger

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

triggerIdstringRequired

The ID of the trigger for which to fetch the information

Responses

200

OK

application/json

idstringRead-onlyRequired

ID of the the trigger

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

createdAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been created.

changedAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been changed.

activeinteger · integerRead-onlyRequired

Status of the trigger

• 1 the trigger is enabled
• 0 the trigger is disabled

403

Invalid credentials

404

Invalid ID

500

Internal Server Error

application/json

get

/v3/trigger/{triggerId}

HTTPcURLJavaScriptPython

GET /v3/trigger/{triggerId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "conditions": [
      {
        "conditionId": 1,
        "conditionValues": [
          "text"
        ]
      }
    ],
    "rules": [
      {
        "ruleAction": 1,
        "ruleDataType": 1,
        "rule": {
          "operator": 1,
          "triggerWindow": 1,
          "threshold": 1
        }
      }
    ],
    "actions": [
      {
        "action": 1,
        "actionParameters": {
          "methodId": 1,
          "timeout": 1
        }
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "active": 1
  }
]

Update the details of a trigger

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

triggerIdstringRequired

The ID of the trigger

Body

application/json

idstringRead-onlyRequired

ID of the the trigger

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

createdAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been created.

changedAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been changed.

activeinteger · integerRead-onlyRequired

Status of the trigger

• 1 the trigger is enabled
• 0 the trigger is disabled

Responses

200

OK

application/json

idstringRead-onlyRequired

ID of the the trigger

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

createdAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been created.

changedAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been changed.

activeinteger · integerRead-onlyRequired

Status of the trigger

• 1 the trigger is enabled
• 0 the trigger is disabled

403

Invalid credentials

404

Invalid ID

500

Internal Server Error

application/json

put

/v3/trigger/{triggerId}

HTTPcURLJavaScriptPython

PUT /v3/trigger/{triggerId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "name": "text",
  "description": "text",
  "conditions": [
    {
      "conditionId": 1,
      "conditionValues": [
        "text"
      ]
    }
  ],
  "rules": [
    {
      "ruleAction": 1,
      "ruleDataType": 1,
      "rule": {
        "operator": 1,
        "triggerWindow": 1,
        "threshold": 1
      }
    }
  ],
  "actions": [
    {
      "action": 1,
      "actionParameters": {
        "methodId": 1,
        "timeout": 1
      }
    }
  ]
}

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "conditions": [
      {
        "conditionId": 1,
        "conditionValues": [
          "text"
        ]
      }
    ],
    "rules": [
      {
        "ruleAction": 1,
        "ruleDataType": 1,
        "rule": {
          "operator": 1,
          "triggerWindow": 1,
          "threshold": 1
        }
      }
    ],
    "actions": [
      {
        "action": 1,
        "actionParameters": {
          "methodId": 1,
          "timeout": 1
        }
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "active": 1
  }
]

Delete a trigger

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

triggerIdstringRequired

The ID of the trigger

Responses

204

No Content

403

Invalid credentials

404

Invalid ID

500

Internal Server Error

application/json

delete

/v3/trigger/{triggerId}

HTTPcURLJavaScriptPython

DELETE /v3/trigger/{triggerId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get the list of all the triggers

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

idstringRead-onlyRequired

ID of the the trigger

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

createdAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been created.

changedAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been changed.

activeinteger · integerRead-onlyRequired

Status of the trigger

• 1 the trigger is enabled
• 0 the trigger is disabled

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/trigger/

HTTPcURLJavaScriptPython

GET /v3/trigger/ HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "conditions": [
      {
        "conditionId": 1,
        "conditionValues": [
          "text"
        ]
      }
    ],
    "rules": [
      {
        "ruleAction": 1,
        "ruleDataType": 1,
        "rule": {
          "operator": 1,
          "triggerWindow": 1,
          "threshold": 1
        }
      }
    ],
    "actions": [
      {
        "action": 1,
        "actionParameters": {
          "methodId": 1,
          "timeout": 1
        }
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "active": 1
  }
]

Get the summary of all the triggers, only id, name and description

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

ID of the type

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/trigger/summary

HTTPcURLJavaScriptPython

GET /v3/trigger/summary HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "description": "text"
  }
]

Create a trigger

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

idstringRead-onlyRequired

ID of the the trigger

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

createdAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been created.

changedAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been changed.

activeinteger · integerRead-onlyRequired

Status of the trigger

• 1 the trigger is enabled
• 0 the trigger is disabled

Responses

200

OK

application/json

idstringRead-onlyRequired

ID of the the trigger

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

createdAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been created.

changedAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been changed.

activeinteger · integerRead-onlyRequired

Status of the trigger

• 1 the trigger is enabled
• 0 the trigger is disabled

403

Invalid credentials

500

Internal Server Error

application/json

post

/v3/trigger

HTTPcURLJavaScriptPython

POST /v3/trigger HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "name": "text",
  "description": "text",
  "conditions": [
    {
      "conditionId": 1,
      "conditionValues": [
        "text"
      ]
    }
  ],
  "rules": [
    {
      "ruleAction": 1,
      "ruleDataType": 1,
      "rule": {
        "operator": 1,
        "triggerWindow": 1,
        "threshold": 1
      }
    }
  ],
  "actions": [
    {
      "action": 1,
      "actionParameters": {
        "methodId": 1,
        "timeout": 1
      }
    }
  ]
}

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "conditions": [
      {
        "conditionId": 1,
        "conditionValues": [
          "text"
        ]
      }
    ],
    "rules": [
      {
        "ruleAction": 1,
        "ruleDataType": 1,
        "rule": {
          "operator": 1,
          "triggerWindow": 1,
          "threshold": 1
        }
      }
    ],
    "actions": [
      {
        "action": 1,
        "actionParameters": {
          "methodId": 1,
          "timeout": 1
        }
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "active": 1
  }
]

Enable a trigger

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

triggerIdstringRequired

The ID of the trigger

Responses

200

OK

application/json

idstringRead-onlyRequired

ID of the the trigger

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

createdAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been created.

changedAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been changed.

activeinteger · integerRead-onlyRequired

Status of the trigger

• 1 the trigger is enabled
• 0 the trigger is disabled

403

Invalid credentials

404

Invalid ID

500

Internal Server Error

application/json

put

/v3/trigger/{triggerId}/enable

HTTPcURLJavaScriptPython

PUT /v3/trigger/{triggerId}/enable HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "conditions": [
      {
        "conditionId": 1,
        "conditionValues": [
          "text"
        ]
      }
    ],
    "rules": [
      {
        "ruleAction": 1,
        "ruleDataType": 1,
        "rule": {
          "operator": 1,
          "triggerWindow": 1,
          "threshold": 1
        }
      }
    ],
    "actions": [
      {
        "action": 1,
        "actionParameters": {
          "methodId": 1,
          "timeout": 1
        }
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "active": 1
  }
]

Disable a trigger

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

triggerIdstringRequired

The ID of the trigger

Responses

200

OK

application/json

idstringRead-onlyRequired

ID of the the trigger

namestringRequired

The name of the trigger

descriptionstringOptional

The description of the trigger

createdAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been created.

changedAtinteger · integerRead-onlyRequired

The unix timestamp when the trigger has been changed.

activeinteger · integerRead-onlyRequired

Status of the trigger

• 1 the trigger is enabled
• 0 the trigger is disabled

403

Invalid credentials

404

Invalid ID

500

Internal Server Error

application/json

put

/v3/trigger/{triggerId}/disable

HTTPcURLJavaScriptPython

PUT /v3/trigger/{triggerId}/disable HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "conditions": [
      {
        "conditionId": 1,
        "conditionValues": [
          "text"
        ]
      }
    ],
    "rules": [
      {
        "ruleAction": 1,
        "ruleDataType": 1,
        "rule": {
          "operator": 1,
          "triggerWindow": 1,
          "threshold": 1
        }
      }
    ],
    "actions": [
      {
        "action": 1,
        "actionParameters": {
          "methodId": 1,
          "timeout": 1
        }
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "active": 1
  }
]

Get list of rule action types

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

ID of the type

descriptionstringRead-onlyRequired

The description of the type

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/trigger/type/ruleActions

HTTPcURLJavaScriptPython

GET /v3/trigger/type/ruleActions HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "description": "text"
  }
]

Get list of rule data types

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

ID of the type

descriptionstringRead-onlyRequired

The description of the type

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/trigger/type/ruleDataTypes

HTTPcURLJavaScriptPython

GET /v3/trigger/type/ruleDataTypes HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "description": "text"
  }
]

Get list of actions types

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

ID of the type

descriptionstringRead-onlyRequired

The description of the type

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/trigger/type/actions

HTTPcURLJavaScriptPython

GET /v3/trigger/type/actions HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "description": "text"
  }
]

Get list of operators

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

ID of the type

descriptionstringRead-onlyRequired

The description of the type

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/trigger/type/operators

HTTPcURLJavaScriptPython

GET /v3/trigger/type/operators HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "description": "text"
  }
]

Get list of conditions

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

ID of the type

descriptionstringRead-onlyRequired

The description of the type

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/trigger/type/conditions

HTTPcURLJavaScriptPython

GET /v3/trigger/type/conditions HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "description": "text"
  }
]

Get list of valueTypes

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

ID of the type

descriptionstringRead-onlyRequired

The description of the type

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/trigger/type/valueTypes

HTTPcURLJavaScriptPython

GET /v3/trigger/type/valueTypes HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "description": "text"
  }
]