Fixing API endpoint URL errors in custom actions – Zendesk

When testing a custom action, you get an error message which indicates the domain or API endpoint is incorrect for the API request.

Causes

This error occurs because the custom action’s API endpoint URL is incorrect. Apps such as Glean, Workday, Oracle Eloqua, and Jira Software Cloud require the API endpoint URL to include a unique identifier specific to your organization. Custom actions cannot generate this identifier because these URLs are dynamic.

For example, Glean’s API requires the subdomain to be specified in the URL when making the API request.

How to fix it

In your app’s API documentation, find the format required for an API endpoint.
Edit the code in your custom action.
- In the Custom Action Builder, in the left panel, click the Advanced tab.
- In the Code editor, find the API URL and adjust it according to the format the app expects.
In the right panel, click Run test. Retesting the action should then allow your custom action to reach your domain with the expected endpoint URL.

Glean

API requests for Glean require a subdomain.

For example, if your Glean subdomain is mycompany-be, the API endpoint URL must contain the subdomain.

https://mycompany-be.glean.com/rest/api/v1/getdocuments.

For more information on Glean’s API, refer to their API documentation.

Workday

API requests for Workday require the tenantHostname and tenant.

For example, the tenantHouse is impl.wd12.myworkday.com and your tenant is mytenant. The API endpoint URL must contain the tenantHouse and tenant.

https://impl-services1.wd12.myworkday.com/ccx/api/v1/mytenant

The URL structure can also be represented more generally as:

https://<tenantHostname>/api/<serviceName>/<version>/<tenant>

You can find this information in the address bar after logging into Workday.

https://impl.wd12.myworkday.com/mytenant/d/home.htmld

For more information on Workday’s API, refer to:

Oracle Eloqua

API requests for Oracle Eloqua require a base URL.

For example, if your Oracle Eloqua base URL is https://secure.p03.eloqua.com, the API endpoint URL must contain the base URL.

https://secure.p03.eloqua.com/API/Rest/2.0?page=5&count=30

For more information on Oracle’s Eloqua’s API, refer to Oracle Eloqua’s API documentation.

Note

The base URL is subject to change from time to time. If you notice that the Zap shows errors or the URL looks different when you log into your Oracle Eloqua account, you might need to update the API endpoint URL in your custom action.

Jira Software Cloud

To make API requests for Jira Software Cloud, you must use the correct base URL and your unique cloud ID.

1. Find the Base URL

The base URL is your Jira instance type, either a Standard Cloud or an Atlassian Government Cloud (AGC) account. Check below the appropriate URL for your instance type.

2. Retrieve the cloud ID

cloudIdis a unique identifier required for every Jira Software Cloud API endpoint. It must be retrieved dynamically via an API call and cannot be hardcoded.

To retrieve your cloudId, make a GET request to the accessible-resources endpoint using the appropriate base URL for your account type.

Example request to retrieve a Cloud ID:

Standard cloud: GET https://api.atlassian.com/oauth/token/accessible-resources
AGC:GET https://api.atlassian-us-gov-mod.com/oauth/token/accessible-resources

3. Build the final URL

Once you have both the base URL and the cloudID, you can construct the full URL in your API call.

Final URL format: [Base URL]/ex/jira/[cloudID]/[API endpoint]

For more information on Jira’s API, refer to: