You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/developers/apps/creating-a-github-app-from-a-manifest.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,9 @@ The person creating the app will be redirected to a GitHub page with an input fi
59
59
`name` | `string` | The name of the GitHub App.
60
60
`url` | `string` | **Required.** The homepage of your GitHub App.
61
61
`hook_attributes` | `object` | The configuration of the GitHub App's webhook.
62
-
`redirect_url` | `string` | The full URL to redirect to after the person installs the GitHub App.
62
+
`redirect_url` | `string` | The full URL to redirect to after a user initiates the creation of a GitHub App from a manifest.{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.0" %}
63
+
`callback_urls` | `array of strings` | A full URL to redirect to after someone authorizes an installation. You can provide up to 10 callback URLs.{% else %}
64
+
`callback_url` | `string` | A full URL to redirect to after someone authorizes an installation.{% endif %}
63
65
`description` | `string` | A description of the GitHub App.
64
66
`public` | `boolean` | Set to `true` when your GitHub App is available to the public or `false` when it is only accessible to the owner of the app.
65
67
`default_events` | `array` | The list of [events](/webhooks/event-payloads) the GitHub App subscribes to.
@@ -96,7 +98,10 @@ This example uses a form on a web page with a button that triggers the `POST` re
96
98
"hook_attributes": {
97
99
"url":"https://example.com/github/events",
98
100
},
99
-
"redirect_url":"https://example.com/callback",
101
+
"redirect_url":"https://example.com/redirect",
102
+
{%if currentVersion =="free-pro-team@latest" or currentVersion =="github-ae@next" or currentVersion ver_gt "enterprise-server@3.0"%}"callback_urls": [
@@ -111,10 +116,11 @@ This example uses a form on a web page with a button that triggers the `POST` re
111
116
})
112
117
</script>
113
118
```
119
+
114
120
This example uses a form on a web page with a button that triggers the `POST` request for an organization account. Replace `ORGANIZATION` with the name of the organization account where you want to create the app.
Copy file name to clipboardExpand all lines: content/developers/apps/creating-a-github-app-using-url-parameters.md
+12-5Lines changed: 12 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,15 @@ The person creating the app can edit the preselected values from the {% data var
22
22
23
23
The following URL creates a new public app called `octocat-github-app` with a preconfigured description and callback URL. This URL also selects read and write permissions for `checks`, subscribes to the `check_run` and `check_suite` webhook events, and selects the option to request user authorization (OAuth) during installation:
24
24
25
-
```
26
-
{% data variables.product.oauth_host_code %}/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_url=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite
27
-
```
25
+
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.0" %}
26
+
```
27
+
{% data variables.product.oauth_host_code %}/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_urls[]=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite
28
+
```
29
+
{% else %}
30
+
```
31
+
{% data variables.product.oauth_host_code %}/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_url=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite
32
+
```
33
+
{% endif %}
28
34
29
35
The complete list of available query parameters, permissions, and events is listed in the sections below.
30
36
@@ -34,8 +40,9 @@ The complete list of available query parameters, permissions, and events is list
34
40
-----|------|-------------
35
41
`name` | `string` | The name of the {% data variables.product.prodname_github_app %}. Give your app a clear and succinct name. Your app cannot have the same name as an existing GitHub user, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your integration takes an action.
36
42
`description` | `string` | A description of the {% data variables.product.prodname_github_app %}.
37
-
`url` | `string` | The full URL of your {% data variables.product.prodname_github_app %}'s website homepage.
38
-
`callback_url` | `string` | The full URL to redirect to after someone authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests.
43
+
`url` | `string` | The full URL of your {% data variables.product.prodname_github_app %}'s website homepage.{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.0" %}
44
+
`callback_urls` | `array of strings` | A full URL to redirect to after someone authorizes an installation. You can provide up to 10 callback URLs. These URLs are used if your app needs to identify and authorize user-to-server requests. For example, `callback_urls[]=https://example.com&callback_urls[]=https://example-2.com`.{% else %}
45
+
`callback_url` | `string` | The full URL to redirect to after someone authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests.{% endif %}
39
46
`request_oauth_on_install` | `boolean` | If your app authorizes users using the OAuth flow, you can set this option to `true` to allow people to authorize the app when they install it, saving a step. If you select this option, the `setup_url` becomes unavailable and users will be redirected to your `callback_url` after installing the app.
40
47
`setup_url` | `string` | The full URL to redirect to after someone installs the {% data variables.product.prodname_github_app %} if the app requires additional setup after installation.
41
48
`setup_on_update` | `boolean` | Set to `true` to redirect people to the setup URL when installations have been updated, for example, after repositories are added or removed.
0 commit comments