Create OAuth Link

This endpoint can be used to generate an OAuth link if you want to completely white label your authentication experience. You can use this endpoint to generate a link which your users can click to redirect to the specified application without rendering the Alloy Embedded Modal.

Note: this endpoint only works with OAuth enabled integrations. To add a credential manually, please use the POST Create Credential API.

This endpoint takes a userId, integrationId, and connectorName as inputs. It should be used in conjunction with the GET Credential Metadata API. credentialName represents the name of the integration you want to call.

If the credential metadata endpoint returns any properties, you must pass them as query string parameters at the end of this call. For example, to generate a oAuthURL for Shopify, you’ll need to add the specify shopifySubdomain in the query paramter of the URI. Your URI may look like /oauthUrl?userId=YOUR_USER_ID&app=shopify&shopSubdomain=YOUR_STORE_NAME