Integrations
Last updated
Last updated
Integrations is a feature to allow Ontime to share its data with other parts of your workflow. Meant for generic software and hardware integrations. This can be set up in the
During the running of your event, Ontime server will go through a few lifecycle events.
The integration feature allows you to leverage these events to send data
On Load - Triggered when an event is loaded
On Start - Triggered when an event starts
On Pause - Triggered when an event is paused
On Stop - Triggered when playback is stopped
On Every Second - Triggered once a second (great for sending your timer data out)
On Finish - Triggered when a timer passes the 0 mark and becomes in overtime
You can embed data from the application runtime in the message using templates /your-message/{{ontime-data}} {{ontime-more-data}}
When the lifecycle event is triggered, your message is parsed, and Ontime places the updated piece of data in place of the template
Extending the example above, you could compose a message that sends the id of the loaded event with
{{titlesPublic.noteNext}}
{{playback}}
{{timer.current}}
The above data defined in runtime data will give you the data from Ontime as it is consumed in-app. For example, all times are in milliseconds.
This is great for software - to - software communications, but it might not be ideal if you want to consume the data yourself.
For this use cases, we have defined a small list of human-readable timer values that you can use in your integration messages. The usage would look like
human.clock
{{human.clock}}
Current clock in (hh:mm:ss)
human.duration
{{human.duration}}
Duration of current timer in (hh:mm:ss)*
human.expectedEnd
{{human.expectedEnd}}
Time at which the current event is expected to finish in (hh:mm:ss)*
human.runningTimer
{{human.runningTimer}}
Current running timer in (hh:mm:ss)*
human.elapsedTime
{{human.elapsedTime}}
Elapsed time of current timer in (hh:mm:ss)*
human.startedAt
{{human.startedAt}}
Time when the current time started (hh:mm:ss)*
This means that any of the data described in the is available to be sent as part of the message payload
Inside the template (double brackets), you can add any of the keys described in . Use the . when referencing a subkey
