Get App Event

This endpoint provides detailed information about a specific app event within your organisation, including its metadata, associated app, and event type (e.g., action or trigger). It helps organisations understand the functionality of the event, integrate it seamlessly with external systems, and effectively utilise it within workflows. By accessing this endpoint, organisations can gain valuable insights, streamline event management, and optimise workflow automation.

Syntax: see 'CCall Structure

Type = 'GET'

'https://connect.cambrionix.com/api/workflows/v1/apps/app-id/events/event-id'

Output	Description
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

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/apps/00000000-0000-0000-0000-000000000001/events/00000000-0000-0000-0000-000000000005' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY2ZjZi'
                                                    

Returns

{
  "result": [
    {
      "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": {}
        }
      }
    }
  ]
}
                                                    

Errors

If there is an error in the API method then JSON-RPC Error Object a will be returned