Create an Embedded link for an integration

GET 
https://embedded.runalloy.com/2024-03//users/:userId/integrations/:integrationId/install-url

This endpoint generates an alloy Link. For more details on Embedded Link, please read this tutorial.

Request

Path Parameters

userId stringrequired

The user to generate the Embedded Link for

integrationId stringrequired

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

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

url string

Example (from schema)

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

Result

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://embedded.runalloy.com/2024-03/users/:userId/integrations/:integrationId/install-url' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://embedded.runalloy.com/2024-03

Parameters

userId — pathrequired

integrationId — pathrequired

Authorization — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!