CloudRadial AutomationAI connects to ServiceAI through an Integration Key, a static key that lets ServiceAI import the published webhooks from your workspace. This article covers what the key is, how to generate it, and how to rotate or revoke it. It is for the Owner and Admin roles.
We'll follow three main steps:
- Understanding the Integration Key
- Generating the key
- Regenerating or revoking the key
Step 1: Understanding the Integration Key
Why are we doing this? Knowing what the key does tells you where it goes and who can manage it.
The Integration Key is a static API key that ServiceAI uses to read your workspace's published webhook catalog. You generate it in the ServiceAI panel on the Settings > Integrations page, then provide both the key and the ServiceAI endpoint shown in that panel to ServiceAI. Only Owners and Admins can generate or revoke it; Members have read-only access.
NOTE: Each CloudRadial product that connects to AutomationAI gets its own key. The Settings > Integrations page shows one panel per product (ServiceAI and UCP), each with its own endpoint and its own key. A key works only for the product it was issued for, so a ServiceAI key cannot be used by UCP or the other way around, and regenerating or revoking one product's key never affects the other. An existing ServiceAI connection keeps working; you do not need to reconnect it.
Step 2: Generating the Key
Why are we doing this? This creates the key and connects ServiceAI to your workspace.
- In the ServiceAI panel on the Settings > Integrations page, select Generate key.
- Copy the key from the ServiceAI key created dialog while it is displayed. The dialog also shows the ServiceAI endpoint, each with its own copy button.
- Paste the key and the endpoint into ServiceAI to finish connecting.
While a key is active, the panel shows its prefix, when it was created, and when it was last used.
REQUIRED: A workspace has only one active ServiceAI Integration Key at a time, and the full key is shown only once, at creation. If it is lost you cannot retrieve it; you must regenerate to get a new one. Copy it into your password manager before you close the dialog.
Step 3: Regenerating or Revoking the Key
Why are we doing this? Use this to rotate a lost or compromised key, or to switch the integration off.
To rotate a lost or compromised key, select Regenerate in the ServiceAI panel and confirm. This revokes the current ServiceAI key immediately and mints a new one, so ServiceAI must be updated with the new key or its next call is denied.
To disable the integration entirely, select Revoke in the ServiceAI panel. ServiceAI is denied on its next call until you generate a new key.
With ServiceAI connected, continue connecting the other tools you plan to automate. See Browsing and installing extensions.
If you are still having trouble, we're here to help! Submit a ticket here for assistance, and don't forget to check our status page to ensure there are no outages in your area.
Connecting CloudRadial UCP
CloudRadial UCP uses its own key from the separate UCP panel on the same Settings > Integrations page; your ServiceAI key does not work for UCP. In CloudRadial UCP, the UCP key and the UCP endpoint shown in that panel are entered under Partner > Settings > Integrations > AutomationAI. Once connected, published workflows appear in Partner > Actions and can be triggered from service requests and problem reports. Runs started from UCP appear in History, where the User column shows the person UCP reported, labeled "reported by UCP" to show it was supplied by UCP rather than a signed-in AutomationAI user. See Using Actions and Connecting AutomationAI to CloudRadial UCP.
Comments
0 comments
Please sign in to leave a comment.