Trigger a real-time logging event

Triggers an event on the device channel. Can be used for logging a quick comment, or for other things that haven't been dreamed up yet!

Path parameters

channel_idstringRequiredformat: "uuid"

Device channel id

input_indexintegerRequired>=0

An 0-indexed integer that will be used to identify the input

Headers

x-client-versionstringOptionalDefaults to 0.0.0

Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version.

For more on semantic versions, see here: https://semver.org/

Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/

Request

This endpoint expects an object.

action_typeenumOptional

Allowed values:

offsetintegerOptional>=0

startobjectOptional

durationobjectOptional

1	import requests
2
3	url = "https://api.frame.io/v2/devices/channels/channel_id/inputs/1/trigger"
4
5	payload = {}
6	headers = {"Content-Type": "application/json"}
7
8	response = requests.post(url, json=payload, headers=headers)
9
10	print(response.json())

Path parameters

Headers

Request

Response

Errors