Troubleshooting the REST API Setup

HTTP Status Code	401 Unauthorized
Error Message(s)	- The access token is expired. Please reauthorise the account. - No Authorization Header was found. - Invalid API key or access token (unrecognized login or wrong password).

If Authentication Method is No Auth or Basic Auth:

Potential Causes

• No access token was specified to authorize Hevo.

• An invalid access token was specified.

• No authorization key was provided in the Authorization header, or the key name was incorrect.

Suggested Action(s)

• Check the validity of the specified access token.

• Provide the correct keys and key names as required by your Source API for authorizing Hevo.

• If possible, recreate the access token and provide that as your authorization key.

If Authentication Method is OAuth 2.0:

Potential Causes

• The specified authorization (Auth URL) and or authentication (Token URL) URLs are either invalid or incorrect.

• The specified client ID and or client secret are either invalid or incorrect.

Suggested Action(s)

• Refer to your Source API documentation for the correct URLs or contact the API developer for this information.

• Obtain the correct client credentials from your Source application or your Source API administrator.

HTTP Status Code	403 Forbidden
Error Message(s)	The necessary scopes and permissions are not available to complete this request.

If Authentication Method is No Auth or Basic Auth:

Potential Causes

• The necessary scopes for granting Hevo access to your Source data are not specified in the headers

• The necessary headers for authorizing Hevo with a bearer token are missing.

• The specified authorization token does not have the correct permissions to access your Source data.

Suggested Action(s)

• Configure the authentication method supported by your Source. If your Source authenticates using custom headers, you must select No Auth as the authentication method.

• Provide the User-Agent header to authorize Hevo with a bearer token.

• Ensure that the specified authorization token has the correct access permissions.

If Authentication Method is OAuth 2.0:

Potential Causes

• No scopes are granted to the access token.

• Your Source does not grant default scopes to the access token if no scopes are specified while creating the OAuth 2.0 token.

Suggested Action(s)

• Specify all the scopes required by your Source APIs while generating the access token.

• Check your Source API documentation for the default behavior when no scopes are specified and create your access token accordingly.

HTTP Status Code	400 Bad Request
Error Message(s)	Error while generating new access token from user’s login service.

Potential Causes

• The client credentials (client ID and client secret) or login credentials (username and password) provided are either invalid or have changed.

• The grant type used to generate the authorization code for the OAuth 2.0 access token is either incorrect or is not supported by Hevo.

• The app registered for Hevo does not have permission to request an OAuth 2.0 access token.

• The specified redirect URL does not match the one provided while registering the app for Hevo.

• The refresh token issued earlier for your OAuth2.0 access token is no longer valid.

Suggested Action(s)

• Provide the correct client or login credentials.

• Ascertain the validity of the client and login credentials.

• Specify the grant type as Authorization Code when generating the OAuth 2.0 access token.

• Correct the redirect URL to match the one configured in your registered Hevo app.

• Provide any additional scopes required by your Source to obtain a refresh token and create the OAuth 2.0 access token again. Refer to your Source API documentation for information on the supported OAuth 2.0 scopes.

HTTP Status Code	404 Not Found
Error Message(s)	- The requested resource is not available. - Failed to get a response.

Potential Causes

• The specified REST API endpoint URL is incorrect.

• A private API is configured, but Hevo’s IP addresses do not have access to connect.

Suggested Action(s)

• Check the URL and provide the correct one.

• Allow Hevo to connect to the private APIs by adding the Hevo IP addresses for your region to the list of hosts allowed by your Source.

HTTP Status Code	405 Method not allowed
Error Message(s)	NA

Potential Causes

• The authentication URL (Token URL) specified for token exchange while creating the OAuth 2.0 access token is incorrect.

• The grant type used to generate the authorization code for the OAuth 2.0 access token is either incorrect or is not supported by Hevo.

Suggested Action(s)

• Refer to your Source API documentation for the correct authentication URL or contact the API developer for this information.

• Specify the grant type as Authorization Code when generating the OAuth 2.0 access token.

HTTP Status Code	NA
Error Message(s)	The data root <data root> doesn’t contain an object in API response.

Potential Causes

• The specified data root is an invalid JSONPath expression or does not point to a JSON array or object.

• The rate limit may have been exceeded.

Suggested Action(s)

• Select one of the data roots suggested by Hevo.

• Specify a data root that points to a list of objects to be replicated. Ensure that each element of the data root returns a JSON object.

• You can either check the API response after the API limits are reset or perform the actions suggested in The maximum limit was reached section.

HTTP Status Code	429 Too Many Requests
Error Message(s)	The rate limit for this plan has been exceeded.

Potential Causes

• The number of API calls made by the connected users is more than the limit allowed by the Source application for the subscribed plan.

• Hevo is generating multiple API calls, causing the rate limit to be exceeded.

• Multiple login attempts with incorrect credentials have been made.

Suggested Action(s)

• Check the Source API documentation for the rate limits and, if needed, upgrade your Source account subscription plan.

• Configure Hevo to ingest data at a lower frequency from your Source API.

• Ensure that the login credentials provided to Hevo are correct.