https://auth.bundleup.io/authorize?client_id=YOUR_CLIENT_ID&integration_id=github&redirect_uri=https%3A%2F%2Fapp.example.com%2Fcallback&external_id=user_42&state=Rk3jX9
https://app.example.com/callback?state=Rk3jX9&code=Yx8k2...
https://app.example.com/callback?state=Rk3jX9&error=access_denied&error_description=The+user+denied+access
Auth API
Authorize
Start the authorization flow. Open this URL in the user’s browser.
GET
/
authorize
https://auth.bundleup.io/authorize?client_id=YOUR_CLIENT_ID&integration_id=github&redirect_uri=https%3A%2F%2Fapp.example.com%2Fcallback&external_id=user_42&state=Rk3jX9
https://app.example.com/callback?state=Rk3jX9&code=Yx8k2...
https://app.example.com/callback?state=Rk3jX9&error=access_denied&error_description=The+user+denied+access
Redirect the user’s browser to this URL to start connecting an account. BundleUp validates the parameters, then sends the user to the provider’s consent screen. When the flow finishes, the user is redirected to your
If
redirect_uri.
This is a browser URL, not an API call: don’t send your API key, and don’t call it from your backend.
See Connecting user accounts for the full flow.
Query parameters
string
required
Your workspace’s client ID, from Auth in the dashboard.
string
required
The identifier of the integration to connect, for example
github.string
required
Where to send the user when the flow ends. Must exactly match a redirect URI registered under Auth.
string
Your own reference for this connection, usually your user ID. Returned when you exchange the code, and included in webhooks.
string
Any value. Returned unchanged on the redirect to
redirect_uri, on success and on error. Use a random value per flow to prevent CSRF.Result
The user has 10 minutes to complete the flow. Then BundleUp redirects toredirect_uri with:
string
On success. A one-time code to exchange for the connection ID. Expires after 5 minutes. Single use.
string
On failure. The provider’s error code (such as
access_denied), or invalid_request (the provider returned no code) or token_error (the provider’s token exchange failed).string
On failure. A human-readable description.
string
Your
state, if you sent one.client_id, integration_id or redirect_uri is missing or invalid, BundleUp shows an error page and doesn’t redirect.
https://auth.bundleup.io/authorize?client_id=YOUR_CLIENT_ID&integration_id=github&redirect_uri=https%3A%2F%2Fapp.example.com%2Fcallback&external_id=user_42&state=Rk3jX9
https://app.example.com/callback?state=Rk3jX9&code=Yx8k2...
https://app.example.com/callback?state=Rk3jX9&error=access_denied&error_description=The+user+denied+access
Was this page helpful?