- Getting started
- Notifications
- Licensing
- Troubleshooting
- Connector Builder
- Act! 365
- Active Directory - Preview
- ActiveCampaign
- Adobe Acrobat Sign
- Adobe PDF Services
- Amazon Bedrock
- Amazon Connect
- Amazon Polly
- Amazon SES
- Amazon Transcribe
- Amazon Web Services
- Anthropic Claude
- Asana
- AWeber
- Azure AI Document Intelligence
- Azure Maps
- BambooHR
- Box
- Brevo
- Calendly
- Campaign Monitor
- Cisco Webex Teams
- Citrix Hypervisor
- Citrix ShareFile
- Clearbit
- Confluence Cloud
- Constant Contact
- Coupa
- Customer.io
- Datadog
- Deputy
- DocuSign
- Drip
- Dropbox
- Egnyte
- Eventbrite
- Exchange Server - Preview
- Exchangerates
- Expensify
- Facebook
- Freshbooks
- Freshdesk
- Freshservice
- GetResponse
- GitHub
- Gmail
- Google Cloud Platform
- Google Docs
- Google Drive
- Google Maps
- Google Sheets
- Google Speech-to-Text
- Google Tasks - Preview
- Google Text-to-Speech
- Google Vertex
- Google Vision - Preview
- Google Workspace
- GoToWebinar
- Greenhouse
- Hootsuite
- HTTP Webhook - Preview
- Hubspot CRM
- HubSpot Marketing
- HyperV - Preview
- iContact
- Insightly CRM
- Intercom
- Jira
- Keap
- Klaviyo
- LinkedIn
- Mailchimp
- MailerLite
- Mailgun
- Mailjet
- Marketo
- Microsoft 365
- Microsoft Azure
- Microsoft Azure Active Directory
- Microsoft Azure OpenAI
- Microsoft Dynamics 365 CRM
- Microsoft OneDrive & Sharepoint
- Microsoft Outlook 365
- Microsoft Sentiment
- Microsoft Teams
- Microsoft Translator
- Microsoft Vision
- Miro
- NetIQ eDirectory
- Okta
- OpenAI
- Oracle Eloqua
- Oracle NetSuite
- PagerDuty
- PayPal
- PDFMonkey
- Pinecone
- Pipedrive
- QuickBooksOnline
- Quip
- Salesforce
- Salesforce Marketing Cloud
- SAP BAPI
- SAP Cloud for Customer
- SAP Concur
- SAP OData
- SendGrid
- ServiceNow
- Shopify
- Slack
- SmartRecruiters
- Smartsheet
- Snowflake
- Stripe
- Sugar Enterprise
- Sugar Professional
- Sugar Sell
- Sugar Serve
- System Center - Preview
- TangoCard
- Todoist
- Trello
- Twilio
- VMware ESXi vSphere
- watsonx.ai
- WhatsApp Business
- WooCommerce
- Workable
- Workday
- X (formerly Twitter)
- Xero
- YouTube
- Zendesk
- Zoho Campaigns
- Zoho Desk
- Zoho Mail
- ZoomInfo
Integration Service for Automation Suite User Guide
Using variables in Connector Builder
Many third-party applications that UiPath® can connect with require some sort of dynamic setup, specifically when building the connector for a broader audience. The Base URL might require an organization parameter, every API call might require input that was returned on authentication, etc.
{organizationId}
or responseKey
for these kinds of
processes.
This page describes the areas within Connector Builder where you can add these variables and how to do it.
{myVariable}
.
The Base URL is the URL used by default for any HTTP request. In many cases this URL is static to the third-party application and, as such, using variables is out of scope. Some vendors require to address all API calls to your specific instance of their application or add some sort of identifier into the base path identifying your identity.
Let’s use the example of connecting to your UiPath Orchestrator instance, which requires organization and tenant details in the Base URL. That is used later on as the base path for any future request. When users import this connector onto their tenant and create a connection, you can ask them for that information by adding these parameters as variables and requesting them on the authentication screen.
{organization}
and
{tenant}
notation.
In the authentication setup, the details are localized within the table that lists all parameters, disregarding the Authentication type. The table provides a quick inline Edit option or a more advanced screen by using the More options menu .
{organization}
and {tenant}
.When you add a new authentication parameter, you must set the Name (how you want to specific field to be displayed in the connection screen), its Value (which you can leave empty), and Ask the user field, if you want to the parameter to be required during authentication.
To define a variable for a parameter, select the More options menu .
In this example, the Organization name parameter, which is requested to the user (Ask the user is set to Yes), is sent to the provider as organization (name) and path (type).
The same thing is done for tenant. Then, in the authentication screen, Organization name and Tenant name are required fields, and the organization and tenant are part of the Base URL.
GETBYID
that take in a
{id}
which is then also represented in the parameters section.
{key}
.