Use the Automation Anywhere connector to automate repetitive business processes.
Integrating your application with Automation Anywhere lets you use these operations in an automation. It exposes 8 actions, listed below. Add the connector from the Connections area, authenticate, then select its operations in the automation builder. Capabilities: actions.
Authentication
Before you begin, make sure you have the following information:
Connection Name: Choose a meaningful name for your connection. This name helps you identify the connection within your application or integration settings.
Authentication Type: Automation Anywhere supports Credentials authentication.
Obtaining Your API Key
Log in to your Automation Anywhere Control Room.
Make sure your user role has the Generate API-Key permission. If it doesn't, have an Admin open Administration, then Roles, enable Generate API-Key under the API section for your role, and assign it to your user.
Click your username in the bottom-left corner of the Control Room, then select My Settings.
Click Generate API-Key in the top-right corner of the page.
If a key already exists, confirm the regeneration prompt. This invalidates the previous key and any integrations using it.
Copy the generated API key and store it securely. You'll use it together with your Control Room username to authenticate.
Authentication & setup
Automation Anywhere provides multiple authentication methods for accessing Control Room APIs, including username/API key and JWT token-based authentication.
Username and API Key Authentication
The recommended approach for programmatic API requests.
Step 1: Get Your Credentials
Username: Your Automation Anywhere account username
API Key: A 40-character string (available in your account settings)
Important: Escape backslashes in the API key by replacing
\with\\
Step 2: Use the Credentials Include your username and API key in your API requests. Avoid using passwords in plain-text format to improve security.
Token-Based Authentication
Authentication API is used to generate, validate, and manage JSON Web Tokens (JWT) that are required for authorization in all Enterprise Control Room APIs.
Refresh Tokens
A refresh token allows you to get a new token without needing to collect and authenticate credentials every time a token expires.
OAuth Services
All API calls must contain either:
An authentication token from the Authentication API (generates JWT), or
A bearer token from OAuth services
Actions
Action Name | Description |
|---|---|
Add or update a queue member | Adds or updates a queue member in Automation Anywhere |
Add role as a queue consumer | Adds role as a queue consumer in Automation Anywhere |
Add role as a queue participant | Adds role as a queue participant in Automation Anywhere |
Create a work item model | Creates a work item model for processing in a queue in Automation Anywhere |
Deploy bot | Deploys attended or unattended or headless automations in Automation Anywhere |
Get queue | Retrieves a specific queue by ID in Automation Anywhere |
Get work item model | Retrieves a specific work item model by ID in Automation Anywhere |
Start bot migration | Migrates bots (TaskBots and MetaBots) created using the Enterprise Client version 10 and 11 to Automation 360 in Automation Anywhere |
About the API
Automation Anywhere provides the following API categories:
Authentication API: Generate and manage JWT tokens
Device API: Manage devices and bots
Control Room APIs: Enterprise automation and orchestration
Cloud Control Room APIs: Cloud-based automation management
API Task Real-Time Endpoint: Real-time task execution
These APIs enable programmatic automation, bot management, monitoring, and integration with external systems.
Official documentation
https://docs.automationanywhere.com/bundle/enterprise-v2019/page/auth-api-supported.html