trigger-common

Copied to Clipboard

{ "$id": "trigger-common", "description": "Type definitions for all Trigger document formats.", "definitions": { "commonFieldNames": { "enum": [ "name", "description", "type", "enabled", "actionType", "actionId", "lastExecuted", "migrationVersion" ] }, "commonFields": { "type": "object", "properties": { "name": { "$ref": "common#/definitions/name" }, "description": { "$ref": "common#/definitions/description" }, "enabled": { "type": "boolean", "description": "A flag to determine if this Trigger is enabled or not." }, "actionType": { "type": "string", "description": "The type of component this Trigger will invoke.", "enum": [ "automations" ] }, "actionId": { "description": "The id of the component this Trigger will invoke.", "$ref": "common#/definitions/ObjectIdLikeString" }, "lastExecuted": { "description": "A timestamp in milliseconds of the time this Trigger was last executed.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "migrationVersion": { "$ref": "common#/definitions/migrationVersion" } } }, "formId": { "description": "The id of a JSON Form used to provide inputs to a job from this trigger.", "oneOf": [ { "$ref": "common#/definitions/ObjectIdLikeString" }, { "type": "null" } ] }, "formIdDereferenced": { "description": "The name of a JSON Form used to provide inputs to a job from this trigger.", "oneOf": [ { "$ref": "common#/definitions/name" }, { "type": "null" } ] }, "formData": { "description": "A JSON object created by filling out the associated JSON Form.", "oneOf": [ { "type": "object" }, { "type": "null" } ], "examples": [ { "deviceName": "ATL-123", "action": "SYNC" }, { "ip": "1.2.3.4", "name": "myNewDevice" } ] }, "formSchemaHash": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "jst": { "oneOf": [ { "$ref": "common#/definitions/ObjectIdLikeString" }, { "type": "null" } ] }, "jstDereferenced": { "oneOf": [ { "type": "object" }, { "type": "null" } ] } } }