Use the Hevo API to automate single and bulk actions that you perform in the Hevo interface. The API provides you the flexibility to act on your Pipelines based on specific data or business triggers and integrate responses from these APIs into your data management and analysis activities.

The Hevo API is organized around REST. It uses HTTP requests to access and use data, accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.

What is REST API?

REST stands for REpresentational State Transfer. A REST API (also known as RESTful API) is a web API that follows the REST architecture and can interact with RESTful web services. REST APIs use HTTP requests to interact with the data. For example, with a REST API, you can use HTTP requests such as Get, Post, Update, Delete to read, create, update, and delete data stored on a computer or a system. You can specify the parameters in the request body of the API that help to identify the data and the actions to be performed on it.

In API terminology, the endpoint is the URL used to make the request. The resource signifies the dataset that is returned. For example, in the endpoint{id} for fetching a Pipeline based on the ID, the resource is pipelines.

You can have multiple endpoints with the same resource based on the action you need to perform.

Refer to the API Reference section to find information about the different endpoints that are available for each resource and how to successfully use each of these. You can also try these out with sample values and review the response.

API Breaking Changes Policy

Hevo will provide 12 months advance notice prior to the date of removing or changing an existing API of a Cloud Service that you have deployed which would require you to update your code.