Creating a GitHub App using URL parameters

About GitHub App URL parameters

You can add query parameters to these URLs to preselect the configuration of a GitHub App on a personal or organization account:

• Personal account: http(s)://HOSTNAME/settings/apps/new
• Organization account: http(s)://HOSTNAME/organizations/:org/settings/apps/new

The person creating the app can edit the preselected values from the GitHub App registration page, before submitting the app. If you do not include required parameters in the URL query string, like name, the person creating the app will need to input a value before submitting the app.

For apps that require a secret to secure their webhook, the secret's value must be set in the form by the person creating the app, not by using query parameters. For more information, see "Una vez que tu servidor se configure para recibir cargas útiles, éste escuchará a cualquiera de ellas que se envíe a la terminal que configuraste.."

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:

http(s)://HOSTNAME/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

The complete list of available query parameters, permissions, and events is listed in the sections below.

GitHub App configuration parameters

Name	Type	Description
name	string	The name of the 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.
description	string	A description of the GitHub App.
url	string	The full URL of your GitHub App's website homepage.
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 generate a user access token. For example, callback_urls[]=https://example.com&callback_urls[]=https://example-2.com. For more information, see "Al crear un GitHub App, puede especificar una URL de devolución de llamada.."
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.
setup_url	string	The full URL to redirect to after someone installs the GitHub App if the app requires additional setup after installation.
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.
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.
webhook_active	boolean	Set to false to disable webhook. Webhook is enabled by default.
webhook_url	string	The full URL that you would like to send webhook event payloads to.
events	array of strings	Webhook events. Some webhook events require read or write permissions for a resource before you can select the event when registering a new GitHub App. See the "GitHub App webhook events" section for available events and their required permissions. You can select multiple events in a query string. For example, events[]=public&events[]=label.
single_file_name	string	This is a narrowly-scoped permission that allows the app to access a single file in any repository. When you set the single_file permission to read or write, this field provides the path to the single file your GitHub App will manage. If you need to manage multiple files, see single_file_paths below.
single_file_paths	array of strings	This allows the app to access up ten specified files in a repository. When you set the single_file permission to read or write, this array can store the paths for up to ten files that your GitHub App will manage. These files all receive the same permission set by single_file, and do not have separate individual permissions. When two or more files are configured, the API returns multiple_single_files=true, otherwise it returns multiple_single_files=false.

GitHub App permissions

You can select permissions in a query string using the permission name in the following table as the query parameter name and the permission type as the query value. For example, to select Read & write permissions in the user interface for contents, your query string would include &contents=write. To select Read-only permissions in the user interface for blocking, your query string would include &blocking=read. To select no-access in the user interface for checks, your query string would not include the checks permission.

Permission	Description
administration	Grants access to various endpoints for organization and repository administration. Can be one of: none, read, or write.
checks	Grants access to the Checks API. Can be one of: none, read, or write.
contents	Grants access to various endpoints that allow you to modify repository contents. Can be one of: none, read, or write.
deployments	Grants access to the Deployments API. Can be one of: none, read, or write.
emails	Grants access to the Emails API. Can be one of: none, read, or write.
followers	Grants access to the Followers API. Can be one of: none, read, or write.
gpg_keys	Grants access to the GPG Keys API. Can be one of: none, read, or write.
issues	Grants access to the Issues API. Can be one of: none, read, or write.
keys	Grants access to the Public Keys API. Can be one of: none, read, or write.
members	Grants access to manage an organization's members. Can be one of: none, read, or write.
organization_hooks	Grants access to the Organization Webhooks API. Can be one of: none, read, or write.
organization_plan	Grants access to get information about an organization's plan using the "Las organizaciones" endpoint. Can be one of: none or read.
organization_projects	Grants access to the Projects API. Can be one of: none, read, write, or admin.
pages	Grants access to the Pages API. Can be one of: none, read, or write.
plan	Grants access to get information about a user's GitHub plan using the "Usuarios" endpoint. Can be one of: none or read.
pull_requests	Grants access to various pull request endpoints. Can be one of: none, read, or write.
repository_hooks	Grants access to the Repository Webhooks API. Can be one of: none, read, or write.
repository_projects	Grants access to the Projects API. Can be one of: none, read, write, or admin.
secret_scanning_alerts	Grants access to the Secret scanning API. Can be one of: none, read, or write.
security_events	Grants access to the Code scanning API. Can be one of: none, read, or write.
single_file	Grants access to the Contents API. Can be one of: none, read, or write.
starring	Grants access to the Starring API. Can be one of: none, read, or write.
statuses	Grants access to the Statuses API. Can be one of: none, read, or write.
team_discussions	Grants access to the Team Discussions API and the Team Discussion Comments API. Can be one of: none, read, or write.
vulnerability_alerts	Grants access to receive Dependabot alerts in a repository. See "Acerca de las alertas Dependabot" to learn more. Can be one of: none, read, or write.
watching	Grants access to list and change repositories a user is subscribed to. Can be one of: none, read, or write.

GitHub App webhook events

Webhook event name	Required permission	Description
check_run	checks	Ha ocurrido una actividad de ejecución de verificación. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "ejecuciones de comprobación".
check_suite	checks	Ha ocurrido una actividad de suite de verificaciones. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta la API REST de "conjuntos de comprobación".
commit_comment	contents	Se creó un comentario de una confirmación. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "confirmación de comentarios".
create	contents	Se crea una rama o etiqueta de Git. Para obtener más información, consulta la API de REST de "Git database".
delete	contents	Se borra una rama o etiqueta de Git. Para obtener más información, consulta la API de REST de "Git database".
deployment	deployments	Se crea un despliegue. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta la API REST de "Implementaciones".
deployment_status	deployments	Se crea un despliegue. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "implementaciones".
fork	contents	Un usuario bifurca un repositorio. Para obtener más información, consulta la API de REST de "Repositorios".
gollum	contents	Se crea o actualiza una página de wiki. Para obtener más información, vea «Acerca de las wikis».
issues	issues	La actividar relacionada con un informe de problemas. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "incidencias".
issue_comment	issues	Actividad relacionada con un comentario a una propuesta o solicitud de cambios. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "comentarios de incidencias".
label	metadata	Actividad relacionada con una etiqueta. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "etiquetas".
member	members	La actividad relacionada con los colaboradores del repositorio. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta la API REST de "colaboradores".
membership	members	La actividad relacionada con la membrecía del equipo. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta la API REST de "Teams".
milestone	pull_request	La actividar relacionada con los hitos. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "hitos".
organization	members	La actividad relacionada con una organización y sus miembros. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "organizaciones".
page_build	pages	Representa un intento de compilación de un sitio de GitHub Pages, haya sido exitoso o no. Una subida a la rama habilitada de GitHub Pages (gh-pages para las páginas de proyecto, la rama predeterminada para las páginas de usuario y de organización) desencadena este evento.
project	repository_projects or organization_projects	Actividad relacionada con instancias de paneles de proyecto. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para obtener más información, vea la API REST de "proyectos".
project_card	repository_projects or organization_projects	Actividad relacionada con las tarjetas de una instancia de panel de proyecto. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para obtener más información, vea la API REST de "tarjetas de proyecto".
project_column	repository_projects or organization_projects	Actividad relacionada con las columnas de una instancia de panel de proyecto. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "columnas de proyecto".
public	metadata	Cuando un repositorio privado se hace público. Sin duda alguna: el mejor evento de GitHub Enterprise Server.
pull_request	pull_requests	La actividad relacionada con las solicitudes de extracción. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "solicitudes de incorporación de cambios".
pull_request_review	pull_request	La actividad relacionada con las revisiones de la solicitudes de extracción. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para obtener más información, vea la API REST de "revisiones de solicitudes de incorporación de cambios".
pull_request_review_comment	pull_request	La actividar relacionada con los comentarios de revisión de la solicitud de extracción en el diff unificado de la misma. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para obtener más información, consulte la API de REST de "comentarios de revisiones de solicitudes de incorporación de cambios".
pull_request_review_thread	pull_request	Actividad relacionada con un hilo de comentarios en una solicitud de incorporación de cambios que se marca como resuelto o sin resolver. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga.
push	contents	Se cargó una o más confirmaciones a la rama o etiqueta de un repositorio.
release	contents	La actividad relacionada con un lanzamiento. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "versiones".
repository	metadata	La actividad relacionada con un repositorio. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "repositorios".
status	statuses	Cuando el estado de una confirmación de Git cambia. Para obtener más información, consulta la API de REST de "Confirmaciones".
team	members	La actividad relacionada con el equipo de una organización. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "equipos".
team_add	members	Cuando se agrega un repositorio a un equipo.
watch	metadata	Cuando alguien marca un repositorio con una estrella. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea la API REST de "marcar con estrellas".