How to customize the redirect URL when registering a Github App?

[pieterbreed]

Select Topic Area

Question

Body

I have a registered Github App and in our app we request that users install the app to their account. We do so by presenting our users with a link to github.com/apps/<our-app-name>/installations/new?state=<some-stuff>.

We have the setting ENABLED for Request user authorization (OAuth) during installation, so after making a choice of account, the user is presented with a page titled Install & Authorize <our-app-name> and at the bottom, below the Install & Authorize button, it has this text: Next: you'll be redirected to https://<our-prod-domain-name>/api/external/github-callback.

My question is this: how can I customize that URL during development? I depend on the parameters that URL receives to complete the authorization flow, but during development, that call goes to production and not to localhost.

[pieterbreed]

I'm not integrating with squareup, I'm trying to customize the behavour for github apps specifically.

[schlichtanders]

I am also running into this.

Some notes:

• I couldn't find any documentation about /new?state=, so this probably won't work.
• you can set setup-url or callback-url (if you activated authorization as part of isntallation) to have a redirect ON THE FIRST INSTALLATION
• Second time, the app will already be installed, and the very same url unfortunately points to the settings page of the installation, instead of redirecting automatically in order to realize an authorization flow.

I am currently trying to figure out a way how to automate this kind of... my best guess is to first try user authorization and then after having the user you can check whether the user already installed the app and if not redirect to the installation.

[pieterbreed]

Thank you for your response. I tried to add callback_url and setup_url as query parameters to the github.com/apps/<our-app-name>/installations/new?state=<some-stuff> url, but those did not work. It seems the URL that the user is redirected to after first installation is part of the app's config.

Regarding docs for /new?state=, visit https://docs.github.com/en/apps/sharing-github-apps/sharing-your-github-app#sharing-your-github-app-via-an-install-link and look at point pt 8 where the state parameter is described.

[Yashasv-Prajapati]

Did you find any fix for this? I have tried several things but could not find anything till now :(

[lalitr091]

@pieterbreed did you get any workaround for this. I am also in a similar scenario where I want to redirect to 2nd callback url after user authorizes app installation but it always redirects to the first callback url.

[pieterbreed]

I did not achieve this outcome. In our app we gave the user 3 choices, default which is install & authorize, then Retry Installation & Retry Authorization. Authorization allows you to customize the callback URL and we just learnt to live with this shortcoming.

[horlah]

Actually, this was catered for (maybe recently updated), I guess we all missed it.

Instead of adding multiple callback URL fields here and/or trying to specify it in the installation URL somehow, you should instead uncheck the "Request user authorization (OAuth) during installation" checkbox below the "Callback URL" input and add the callback URL for your Github App installation redirect to the "Setup URL (optional)" input field in the "Post installation" section.

[horlah]

@iamnotstatic see here.

[iamnotstatic]

I see, thanks for pointing that out. However, this approach only works for the initial app installation. Subsequent user actions after installation redirect them to the configuration page instead of the redirect uri

[iamnotstatic]

Did anyone find any fix for this? I have tried several things but could not find anything till now, essentially for the subsequent redirect when the user already has the app installed :(