Access Turvo's Public API and webhooks documentation

Turvo API

Turvo API provides you with the ability to integrate with Turvo through RESTful methods. Our API has predictable, resource-oriented URLs, uses HTTP response codes to indicate API errors, and all requests and responses are in JSON format.


The Turvo Real-time updates API allows you to integrate to Turvo systems and receive on-going updates. The API updates are push notifications that will be transferred to client endpoints on key triggers (or “Events”) in the Turvo workflow.

When a change occurs, an HTTP 'POST' request will be sent to the predetermined callback URL provided by the client. This makes updates more efficient, as you know exactly when a change has happened, and don't need to rely on continuous or even periodic requests when changes aren't happening.

The updates are sent as JSON objects and should be processed by the receiving client according to this reference document.

Accessing the documentation

API documentation can be accessed by Admin users via the Admin console.

To find the Admin console, click on your profile icon in the top right corner and select Admin console from the drop-down.


Then, click the API & Webhooks card.


Once on the API & Webhooks page, you can see the API documentation linked under the Configuring Public API and Webhooks header. Click the here in "API documentation is available here". 


Important note: If your tenant is participating in the API Key management BETA, API documentation can be accessed by clicking the question mark icon at the top right corner of the screen.


This will take you to an external site where our comprehensive API documentation is located.  Additional details regarding API overview, updates, and usage can be found on this page using the left navigation bar. 


Protip: For information on creating and managing your API and Webhooks profiles, see our Using Turvo's self-service Public API and webhooks article. 

Was this article helpful?

0 out of 0 found this helpful