FAQs

Are Hevo APIs free?

Yes, the Hevo API is available for free to all Trial Account users and users on Free and paid plans.

Which authentication scheme does Hevo use for the APIs?

Basic. The API token and secret key that you provide as the username and password during authentication is combined with a colon (:) and sent as a Base64-encoded key in the header of the API request.

Does Hevo offer any helper libraries or SDKs?

As of now, we do not provide these. All the major languages provide support to make API calls these days. Any popular library in your language of choice can be used to make these API calls.

Does Hevo provide webhook support for sending information on events occurring in the Hevo app?

No. Hevo uses Alert emails and notifications to inform you of any events occurring in your Hevo account.

Does Hevo provide any sandbox/testing account to test the APIs?

No.

What should I do in case of permission-related errors like “account members are not permitted to perform this action”?

Create the API keys using an owner account to get full access. The current keys were probably generated with a member account.

Why do I need to authenticate myself on each endpoint?

This is required, as, without the credentials, it is impossible for Hevo to identify the user making the API call.

Does authenticating once on an endpoint work for the entire team?

No. Each API request should contain valid creds irrespective of the user who is making the request, the location from where they are making the request, and however many times they make the same request.

What happens if my Pipeline is already running as per the ingestion schedule set up in the Hevo app, and I trigger it via the API endpoint?

If the Pipeline is already ingesting data and a Run Pipeline operation is triggered via the API, this results in a no-op. Further, triggering ingestion using the API does not affect the scheduled ingestion for the object. That continues to occur as per the frequency set for the Pipeline.

Why does the API response have fewer properties than the response template?

Some properties are optional and make sense only in certain scenarios. For example, webhook_url in the pipeline object is only relevant for Webhook-type sources. The response schema itself is generic, but the actual response returned always contains only the valid and relevant elements.

How can I check the status of my Pipeline using Hevo API?

You can check the status of the Pipelines using the following steps. These apply to Pipelines created via the dashboard or using Hevo API. To do this:

  1. Go to the Get Pipeline page.

  2. Use the panel on the right to make your API request.

  3. Click on the scripting language you want to use.

    Code ToggleCode Toggle

    If your preferred language is not displayed, click the More icon and select it.

    Select LanguageSelect Language

  4. Specify your authentication details and select the Base URL from the drop-down.

Base URLBase URL

The API request is automatically displayed below the Base URL. For example, if you selected Shell as your language, your request is:

curl --location 
2     --request GET 'http://<env>.hevodata.com/api/public/v2.0/pipelines/<id>' \
3     --header 'Authorization: Basic <token>'
  1. Click the Try It! button to make your API request.

    This request returns the Pipeline object with status and health_status fields. The value of these fields in the API response indicates the status of your Pipeline.

    FieldValueIndicates
    statusACTIVEThe Pipeline is active.
    INACTIVEThe Pipeline is paused.
    health_statusOKThe Pipeline is working.
    FAILEDThe Pipeline has failed.

    If the Pipeline is deleted, you get a 404 error response with the message: Pipeline not found.