Get Workflow Event List
This endpoint provides a comprehensive list of app events available within your organisation, offering detailed information about each event's metadata, associated app, and event type (e.g., actions or triggers). It enables organisations to explore and understand the functionality of each event, integrate seamlessly with external systems, and efficiently utilise these events within workflows.
Syntax: see 'CCall Structure
Type = 'GET'
|
'https://connect.cambrionix.com/api/workflows/v1/apps/events' |
Returns:
|
{ "result": [ { "created": { "time": time }, "updated": { "time": time }, "id": "event-id", "name": "event-name", "description": "event-description", "type": "event-type", "app": { "id": "app-id" }, "schema": { "options": { "type": "schema-type", "properties": {}, "default": {} }, "output": { "type": "schema-type", "properties": { "success": { "type": "schema-type", "default": true } }, "default": {} } } } ] } |
| Output | Description |
|---|---|
| time | The hub time, shown as an integer in ms |
| app-id | This is the id of the app as a unique 128-bit number |
| event-id | This is the id of the event as a unique 128-bit number |
| event-name | This is the name of the event |
| event-description | This is a description of the event |
| event-type | This is the type of event see Event Types |
| schema-type | This is the type of Schema for the event see Schema Types |
Example
curl -X 'GET' \
'https://connect.cambrionix.com/api/workflows/v1/events' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzNzc1LTk'Returns
{
"result": [
{
"created": {
"time": 1731663026506
},
"updated": {
"time": 1731663026506
},
"id": "00000000-0000-0000-0000-000000000001",
"name": "Every Hour",
"description": "Triggers every hour.",
"type": "trigger",
"app": {
"id": "00000000-0000-0000-0000-000000000003"
},
"schema": {
"options": {
"type": "object",
"properties": {
"triggerOnWeekends": {
"title": "Trigger on Weekends",
"description": "Trigger on Weekends",
"type": "boolean",
"default": false
}
},
"default": {
"triggerOnWeekends": true
}
},
"output": {
"type": "object",
"properties": {
"day": {
"type": "string",
"default": "Monday"
},
"month": {
"type": "string",
"default": "January"
},
"year": {
"type": "number",
"default": 2021
},
"unixTimestamp": {
"type": "number",
"default": 1612128000
}
},
"default": {}
}
}
},
{
"created": {
"time": 1731663026837
},
"updated": {
"time": 1731663026837
},
"id": "00000000-0000-0000-0000-000000000005",
"name": "Switch All Ports Off",
"description": "Switches all ports off on all hubs.",
"type": "action",
"app": {
"id": "00000000-0000-0000-0000-000000000001"
},
"schema": {
"options": {
"type": "object",
"properties": {},
"default": {}
},
"output": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"default": true
}
},
"default": {}
}
}
},
{
"created": {
"time": 1731663026685
},
"updated": {
"time": 1731663026685
},
"id": "00000000-0000-0000-0000-000000000002",
"name": "Every Day",
"description": "Triggers every day at a given time.",
"type": "trigger",
"app": {
"id": "00000000-0000-0000-0000-000000000003"
},
"schema": {
"options": {
"type": "object",
"properties": {
"triggerOnWeekends": {
"title": "Trigger on Weekends",
"description": "Trigger on Weekends",
"type": "boolean",
"default": false
},
"time": {
"title": "Time of day",
"description": "Time of day",
"type": "string",
"default": "00:00"
}
},
"default": {
"triggerOnWeekends": true,
"time": "00:00"
}
},
"output": {
"type": "object",
"properties": {
"day": {
"type": "string",
"default": "Monday"
},
"month": {
"type": "string",
"default": "January"
},
"year": {
"type": "number",
"default": 2021
},
"unixTimestamp": {
"type": "number",
"default": 1612128000
}
},
"default": {}
}
}
},
{
"created": {
"time": 1717512150207
},
"updated": {
"time": 1731663026701
},
"id": "00000000-0000-0000-0000-000000000003",
"name": "Every Week",
"description": "Triggers every week on a given day.",
"type": "trigger",
"app": {
"id": "00000000-0000-0000-0000-000000000003"
},
"schema": {
"options": {
"type": "object",
"properties": {
"time": {
"title": "Time of day",
"description": "Time of day",
"type": "string",
"default": "00:00"
},
"day": {
"title": "Day of the week",
"description": "Day of the week",
"type": "string",
"default": "Monday",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
]
}
},
"default": {
"time": "00:00",
"day": "Monday"
}
},
"output": {
"type": "object",
"properties": {
"day": {
"type": "string",
"default": "Monday"
},
"month": {
"type": "string",
"default": "January"
},
"year": {
"type": "number",
"default": 2021
},
"unixTimestamp": {
"type": "number",
"default": 1612128000
}
},
"default": {}
}
}
},
{
"created": {
"time": 1731663026544
},
"updated": {
"time": 1731663026544
},
"id": "00000000-0000-0000-0000-000000000008",
"name": "Interval",
"description": "Triggers on the interval specified.",
"type": "trigger",
"app": {
"id": "00000000-0000-0000-0000-000000000003"
},
"schema": {
"options": {
"type": "object",
"properties": {
"triggerOnWeekends": {
"title": "Trigger on Weekends",
"description": "Trigger on Weekends",
"type": "boolean",
"default": false
},
"interval": {
"title": "Interval",
"description": "The interval to trigger on.",
"type": "number",
"default": 60
}
},
"default": {
"triggerOnWeekends": true,
"interval": 300000
}
},
"output": {
"type": "object",
"properties": {
"day": {
"type": "string",
"default": "Monday"
},
"month": {
"type": "string",
"default": "January"
},
"year": {
"type": "number",
"default": 2021
},
"unixTimestamp": {
"type": "number",
"default": 1612128000
}
},
"default": {}
}
}
},
{
"created": {
"time": 1731663026693
},
"updated": {
"time": 1731663026693
},
"id": "00000000-0000-0000-0000-000000000007",
"name": "Switch Ports Off When Charged",
"description": "Switches any port off that has met provided charge level",
"type": "action",
"app": {
"id": "00000000-0000-0000-0000-000000000001"
},
"schema": {
"options": {
"type": "object",
"properties": {
"chargeLevel": {
"title": "Charge Level",
"description": "The charge level at which to switch the port off",
"type": "number",
"default": 80,
"minimum": 0,
"maximum": 100
}
},
"default": {
"chargeLevel": 80
}
},
"output": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"default": true
}
},
"default": {}
}
}
}
]
}Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned