Data Stream
Data Stream API publishes JSON formatted objects to a configurable webhook URL so that integrators and customers can use the data in business management or analysis software outside of our system.
What is a Webhook?
Webhooks are a way to send a notification, sending a POST request to a chosen URL with a payload containing details about a given event. A Webhook resembles an API call, except in reverse. Rather than the user calling the API to request data, the API reaches out to the user to notify them that something happened.
This is a much more efficient model in contrast to "Polling" a RESTful API on a set interval, comparing this response to the last response and going from there. Consequently, this often results in a rate-limited API resource that serves up far more data than what is actually required.
These topics describe the process to enable and set up Data Stream through Portal API.
Information is available for the following:
Topic | Summary | Supported Platforms |
|---|---|---|
When an order transitions to its final state, a copy of the order publishes to a specified HTTP endpoint. | POS API, Encounter POS, IRIS, Online Ordering | |
This object describes all of the transactional events relative to a cash drawer session. | POS API | |
This object describes the details of deposits performed as part of cash management at the point of sale (POS) terminal. | POS API | |
This object is generated for any time clock event, such as Clock In/Out. | POS API | |
Sends a notification when a site and/or its terminals change the business date. | POS API | |
This object includes a list of specific steps passed by POS during the End of Day (EOD) process, which are verified by the manager. | POS API |