Create Link Token
Generates a Link Token for a Registered User to authenticate with Connectors. Also returns a magic link URL that can be shared with the user to authenticate in a browser.
Authentication
AuthorizationBearer
Token-based authentication with required prefix “Bearer”
Path parameters
registered_user_id
Agent Handler ID of the Registered User
Request
This endpoint expects an object.
connector
Slug of the connector to generate a link token for
external_id
Optional external ID to scope the link token to a specific application credential. Use this when you have multiple OAuth apps for the same connector.
callback_url
Optional URL to redirect the user to after they complete the authentication flow. Must be added to your organization's allowed callback origins first.
state
Optional CSRF protection token returned to your callback_url after authentication. Requires callback_url to be set. Do not include a ‘state’ query parameter in callback_url if using this field.
Response
link_token
magic_link_url
URL that opens a hosted authentication page. Share this with the user so they can connect their account in a browser.