Skip to main content
GET
/
users
/
{userId}
/
integrations
/
{integrationId}
/
install-url
cURL
curl -X GET "https://production.runalloy.com/users/{userId}/integrations/{integrationId}/install-url?userId={{userId}}" \
  -H "Authorization: bearer YOUR_API_KEY" \
  -H "x-api-version: 2025-09"
{
  "url": "https://app.runalloy.com/embedded-install?integrationId=XXXXXXX&token=YYYYYYYY.ZZZZZZZZZZZZZ.WWWWWWWWWWWWWW-VVVVVVVVV&forgeMode=engaged&alwaysShowCredentials=true"
}

Documentation Index

Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
default:bearer YOUR_API_KEY
required
​
x-api-version
string
default:2025-09
required

The version of the API to use. The current API version is 2025-09.

Path Parameters

​
integrationId
string
required

The Id of the integration you want to generate the Embedded Link for

Query Parameters

​
userId
string
required

The user to generate the Embedded Link for

Response

200 - application/json

200

​
url
string
Example:

"https://app.runalloy.com/embedded-install?integrationId=XXXXXXX&token=YYYYYYYY.ZZZZZZZZZZZZZ.WWWWWWWWWWWWWW-VVVVVVVVV&forgeMode=engaged&alwaysShowCredentials=true"