Skip to main content
Skip table of contents

Trigger contents

Trigger

Example contents

Notes

$trigger/messaging/publish

This trigger does not appear to fire. Are there only certain instances when this trigger would fire?

$trigger/messaging/subscribe

CODE
{
    "topic": "TestTopic",
    "trigger": "Messaging::Subscribe",
    "userId": "ae99dfa00c8297c6bc92db8bd331 :: TestDevice"
}

$trigger/messaging/unsubscribe

CODE
{
    "topic": "TestTopic",
    "trigger": "Messaging::Unsubscribe",
    "userId": "ae99dfa00c8297c6bc92db8bd331 :: TestDevice"
}

$trigger/messaging/user/connected

CODE
{
    "email": "test1@test.com",
    "trigger": "Messaging::MQTTUserConnected"
}

$trigger/messaging/user/disconnected

CODE
{
    "email": "test1@test.com",
    "trigger": "Messaging::MQTTUserDisconnected"
}

$trigger/messaging/device/connected

CODE
{
    "deviceName": "TestDevice",
    "trigger": "Messaging::MQTTDeviceConnected"
}

$trigger/messaging/device/disconnected

CODE
{
    "deviceName": "TestDevice",
    "trigger": "Messaging::MQTTDeviceDisconnected"
}

$trigger/collection/created

CODE
{
  "collectionId": "92a6a9a10cd6d6a1e0afa9d9b776",
  "collectionName": "jim_test_coll",
  "trigger": "Data::CollectionCreated"
}

$trigger/data/created this is the topic this trigger showed up under. Docs show $trigger/collection/created.

2 duplicate triggers were received.

$trigger/collection/updated

CODE
{
  "collectionId": "92a6a9a10cd6d6a1e0afa9d9b776",
  "collectionName": "jim_test_coll",
  "trigger": "Data::CollectionUpdated"
}

$trigger/data/updated this is the topic this trigger showed up under. Docs show $trigger/collection/updated.

2 duplicate triggers were received.

$trigger/collection/deleted

CODE
{
  "collectionId": "92a6a9a10cd6d6a1e0afa9d9b776",
  "collectionName": "jim_test_coll",
  "trigger": "Data::CollectionDeleted"
}

$trigger/data/deleted this is the topic this trigger showed up under. Docs show $trigger/collection/deleted.

$trigger/data/created

CODE
{
  "collectionId": "92a6a9a10cd6d6a1e0afa9d9b776",
  "collectionName": "jim_test_coll",
  "items": [
    {
      "item_id": "c3703cdf-9c30-4b13-876e-99d819864391"
    }
  ],
  "trigger": "Data::ItemCreated"
}

$trigger/data/updated

CODE
{
  "collectionId": "92a6a9a10cd6d6a1e0afa9d9b776",
  "collectionName": "jim_test_coll",
  "items": [
    {
      "col1": "test1",
      "item_id": "c3703cdf-9c30-4b13-876e-99d819864391"
    }
  ],
  "query": {
    "PrimaryKey": null,
    "Order": null,
    "PageSize": 100,
    "PageNumber": 1,
    "Queries": [
      [
        {
          "Field": "item_id",
          "Value": "c3703cdf-9c30-4b13-876e-99d819864391",
          "Operator": "="
        }
      ]
    ],
    "Columns": null,
    "Distinct": "",
    "GroupBy": null,
    "RawQuery": "",
    "AttemptedUnbounded": true
  },
  "trigger": "Data::ItemUpdated"
}

$trigger/data/deleted

CODE
{
  "collectionId": "92a6a9a10cd6d6a1e0afa9d9b776",
  "collectionName": "jim_test_coll",
  "items": [
    {
      "col1": "test1",
      "item_id": "c3703cdf-9c30-4b13-876e-99d819864391"
    }
  ],
  "query": {
    "PrimaryKey": null,
    "Order": null,
    "PageSize": 1,
    "PageNumber": 1,
    "Queries": [
      [
        {
          "Field": "item_id",
          "Value": "c3703cdf-9c30-4b13-876e-99d819864391",
          "Operator": "="
        }
      ]
    ],
    "Columns": null,
    "Distinct": "",
    "GroupBy": null,
    "RawQuery": "",
    "AttemptedUnbounded": false
  },
  "trigger": "Data::ItemDeleted"
}

$trigger/user/created

CODE
{
    "trigger": "User::UserCreated",
    "user": {
        "cb_service_account": false,
        "cb_token": "",
        "creation_date": 1645023295,
        "email": "Testuser@test.com",
        "user_id": "fec0e8a00ce0c5c0a2dfbfe19414"
    }
}

$trigger/user/updated

CODE
{
    "query": {
        "FILTERS": [
            [
                {
                    "EQ": {
                        "user_id": "8ac3e8a00cdaefe8d08cddf2ae1b"
                    }
                }
            ]
        ],
        "PAGENUM": 0,
        "PAGESIZE": 0,
        "SELECTCOLUMNS": null,
        "SORT": []
    },
    "trigger": "User::UserUpdated",
    "user": {
        "cb_service_account": false,
        "email": "Testuser@test.com"
    }
}

$trigger/user/deleted

CODE
{
    "query": {
        "FILTERS": [
            [
                {
                    "EQ": {
                        "user_id": "fec0e8a00ce0c5c0a2dfbfe19414"
                    }
                }
            ]
        ],
        "PAGENUM": 0,
        "PAGESIZE": 0,
        "SELECTCOLUMNS": null,
        "SORT": []
    },
    "trigger": "User::UserDeleted",
    "user": {
        "cb_service_account": false,
        "cb_token": "",
        "creation_date": 1645023295,
        "email": "Testuser@test.com",
        "user_id": "fec0e8a00ce0c5c0a2dfbfe19414"
    }
}

$trigger/device/created

CODE
{
    "device": {
        "allow_certificate_auth": true,
        "allow_key_auth": true,
        "cb_service_account": false,
        "cb_token": "",
        "certificate": "",
        "created_date": 1645023514,
        "description": "",
        "device_key": "c2ffdfa00cdaddcda8fe99a7cb5b :: TriggerTest",
        "enabled": true,
        "last_active_date": 1645023514,
        "name": "TriggerTest",
        "state": "",
        "system_key": "c2ffdfa00cdaddcda8fe99a7cb5b",
        "type": ""
    },
    "deviceName": "TriggerTest",
    "trigger": "Device::DeviceCreated"
}

$trigger/device/updated

CODE
{
    "changes": {
        "allow_key_auth": false,
        "type": "Test"
    },
    "deviceName": "TriggerTest",
    "trigger": "Device::DeviceUpdated"
}

$trigger/device/deleted

CODE
{
    "device": {
        "allow_certificate_auth": true,
        "allow_key_auth": false,
        "cb_service_account": false,
        "cb_token": "",
        "cb_ttl_override": 0,
        "certificate": "",
        "created_date": 1645023514,
        "description": "",
        "device_key": "c2ffdfa00cdaddcda8fe99a7cb5b :: TriggerTest",
        "enabled": true,
        "last_active_date": 1645023533,
        "name": "TriggerTest",
        "state": "",
        "system_key": "c2ffdfa00cdaddcda8fe99a7cb5b",
        "type": "Test"
    },
    "deviceName": "TriggerTest",
    "trigger": "Device::DeviceDeleted"
}

$trigger/startconnectdisconnect/platformstarted

NONE
{
  "trigger": "StartConnectDisconnect::PlatformStarted"
}

Trigger fires manually but stream services haven’t started in time to read.

$trigger/startconnectdisconnect/platformconnectedonedge

NONE
{
  "edgeName":"TriggerTest",
  "trigger":"StartConnectDisconnect::PlatformConnectedOnEdge"
}

$trigger/startconnectdisconnect/platformdisconnectedonedge

NONE
{
  "trigger":"StartConnectDisconnect::PlatformDisconnectedOnEdge"
}

$trigger/startconnectdisconnect/edgestarted

NONE
{
  "edgeName":"TriggerTest",
  "trigger":"StartConnectDisconnect::EdgeStarted"
}

$trigger/startconnectdisconnect/edgedisconnectedonplatform

CODE
{
    "edgeName": "TriggerTest",
    "trigger": "StartConnectDisconnect::EdgeDisconnectedOnPlatform"
}

$trigger/startconnectdisconnect/edgeconnectedonplatform

CODE
{
    "edgeName": "TriggerTest",
    "trigger": "StartConnectDisconnect::EdgeConnectedOnPlatform"
}

$timer/{timerName}

NONE
{
    "name": "testtimer",
    "occurred": "2022-02-16T21:13:00Z",
    "system_key": "c2ffdfa00cdaddcda8fe99a7cb5b"
}

$trigger/file/created/sandbox/platformFile.txt

CODE
{
  "baseName": "platformFile.txt",
  "box": "sandbox",
  "fullPath": "/tmp/clearblade_platform_buckets/8ee8d7eb0b84b69bdd899984b84e/Docker_Files_Test/sandbox/platformFile.txt",
  "relativePath": "platformFile.txt",
  "topicPath": "$trigger/file/created/sandbox/platformFile.txt",
  "topicPathSuffix": "sandbox/platformFile.txt",
  "trigger": "File::FileCreated"
}

$trigger/file/deleted/sandbox/tmp/jim_test.txt

CODE
{
  "baseName": "jim_test.txt",
  "box": "sandbox",
  "fullPath": "/tmp/clearblade_platform_buckets/8ee8d7eb0b84b69bdd899984b84e/Docker_Files_Test/sandbox/tmp/jim_test.txt",
  "relativePath": "tmp/jim_test.txt",
  "topicPath": "$trigger/file/deleted/sandbox/tmp/jim_test.txt",
  "topicPathSuffix": "sandbox/tmp/jim_test.txt",
  "trigger": "File::FileDeleted"
}

$trigger/file/updated/sandbox/platformFile.txt

CODE
{
  "baseName": "platformFile.txt",
  "box": "sandbox",
  "fullPath": "/tmp/clearblade_platform_buckets/8ee8d7eb0b84b69bdd899984b84e/Docker_Files_Test/sandbox/platformFile.txt",
  "relativePath": "platformFile.txt",
  "topicPath": "$trigger/file/updated/sandbox/platformFile.txt",
  "topicPathSuffix": "sandbox/platformFile.txt",
  "trigger": "File::FileUpdated"
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.