REST API

Last updated on Feb 27, 2024

Hevo allows you to bring data from various Sources through its native connectors. However, for situations where you need to fetch data from several applications or an in-house REST API, you can use the REST API connector.

The following image illustrates the key steps that you need to complete to configure REST API as a Source in Hevo:

REST API Source Setup


Limitations

  • By default, Hevo uses the __hevo_id metadata column as the primary key to load data from your REST API Source to the Destination. As a result, you may see duplicate data in the Destination if you have mutable data in your Source. To avoid this, you can set another column as the primary key.

  • Hevo accepts only JSON content type in the response from your REST API Source for the requests that it makes. If your Source API returns a response in any other type, such as CSV, you may see the HTTP Status: 406 error.

  • Hevo’s REST API connector does not support API chaining. In this technique, multiple API calls are used in sequence to achieve a specific task. The response of the last API call feeds the next call, and so on.

    For example, you cannot use the bearer token received in the response of the first API request to authenticate the subsequent API request.



Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Dec-11-2023 2.18.2 - Revamped the page content for clarity and coherence.
- Merged the section, Troubleshooting the Rest API into the Troubleshooting the REST API Setup page.
Nov-28-2023 2.18 Updated section, Configuring REST API as a Source to add information about the No Auth option.
Jul-27-2023 NA Added limitations about JSON content type and authorization code.
Dec-19-2022 2.04 Updated the section, Configuring REST API as a Source to add information about enhanced data root auto-suggestion functionality.
Nov-23-2022 NA Added section, Limitations.
Nov-11-2022 NA Updated section, Troubleshooting the Rest API to include the troubleshooting scenario for Error 404.
Sep-05-2022 NA Updated the See Also section to:
- Add a reference to the REST API FAQs page.
- Remove the reference to the pagination-related FAQ.
Aug-24-2022 1.96 Updated section, Configuring REST API as a Source to add information about data root auto-suggestion by Hevo.
May-10-2022 1.88 - Added information about authentication using OAuth 2.0 protocol.
- Removed section, Testing the API Response.
Dec-20-2021 1.78 Updated the screenshot in step 4 of the section, Configuring REST API as a Source to to reflect the latest UI changes.
Nov-09-2021 1.75 Updated:
- Step 4 in the section, Configuring REST API as a Source to explain the API behavior in case No Pagination is selected.
- The See Also section to add a link to a pagination-related FAQ.
Oct-25-2021 NA Added the Pipeline frequency information in the Data Replication section.
Added the See Also section.
Oct-04-2021 1.73 Updated step 4 in the section, Configuring REST API as a Source to to add:
- A new pagination option, Offset and Limit.
- An option Is the next page URL present in the response? in Session-based pagination.
- Screenshots for each pagination option.
Sep-20-2021 1.72 Updated step 4 in the section, Configuring REST API as a Source to add:
- The Request Body property for the POST method.
- A note in the Data Root property about expected JSONPath expressions.
Apr-06-2021 1.60 Added the following sections:
- Testing the REST API.
- Troubleshooting the REST API.
Updated the section Configuring REST API as a Source to include the field Extract from last record in response.

Tell us what went wrong