automation-hub
2023.10
false
UiPath logo, featuring letters U and I in white

Automation Hub API Guide

Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Apr 19, 2024

Making Automation Hub API Calls

  • Define the token as a bearer -H 'Authorization: Bearer [Tenant ID]/ [Token_generted_from_the_Open API_page].

  • If an App Key was defined when generating the token, it's mandatory that you apply it using the following key: x-ah-openapi-app-key: [defined app key]

  • Adding x-ah-openapi-auth: openapi-token key in the header is mandatory as it indicates the token type.

The easiest way to build the Automation URL is by using the process_slug.

For example, if the process_slug is: process_slug": "onboarding-of-new-employee"

Then the URL for that automation is: https://{yourDomain}/automationhub_/process_slug/onboarding-of-new-employee

The request should look as in the following example:

Content-Type: application/json 
Authorization: Bearer [Tenant ID/Token] 
x-ah-openapi-app-key: [API key if added] 
x-ah-openapi-auth: openapi-tokenContent-Type: application/json 
Authorization: Bearer [Tenant ID/Token] 
x-ah-openapi-app-key: [API key if added] 
x-ah-openapi-auth: openapi-token
  • Use the Copy to Clipboard option available after the Token column to copy-paste your [Tenant ID\Token] value from your Automation Hub Open API page as described in the Generate your Token page.
    docs image
  • If an App Key is included for your token, a Copy to Clipboard option becomes available after the App Key column. Use it to copy-paste your [App Key] value.
    docs image
Note:

The [Token] required for making Automation Hub API calls has limited validity. In case this expired, edit the expiration date by accessing the Actions > Edit option from the Action column corresponding to the token OR generate a new token as mentioned in the Generate your Token page. Otherwise, you will receive a 401 status code.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.