Initial Setup

Modified on Sun, 15 May 2022 at 05:14 PM

All functionality mentioned below is currently in development and is by invite only. If you would like to be an early adopter then please raise a ticket describing how you would like to use the API.


Setting up Endpoints

For Dispatch to be able to send you information of changes made within Dispatch you will need to define an endpoint for the information to be sent to. This should be "HTTPS" however you can use "HTTP" though we would not recommend this.


It is possible other restrictions will be added in the future. 




Update Notifications

The API will send with in notification if the a breaking change is about to occur and what is needed to be done. Third party systems should be writing to look out for these and raise the correct notification to users/system support. For example:


{"terminal":{...},
 "notice": { "breaking": true, 
             "change": "Significant change to the API" } }


The "notice" part will be included when changes are going to occur. These will be used predominantly while the API is in BETA. 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us how can we improve this article!

Select atleast one of the reasons

Feedback sent

We apprciate your effort and will try to fix the article