Creating a GitHub App using URL parameters

You can preselect the settings of a new App GitHub using URL query parameters to quickly set up the new App GitHub's configuration.

En este artículo

About App GitHub URL parameters

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

User account: https://github.com/settings/apps/new
Organization account: https://github.com/organizations/:org/settings/apps/new

The person creating the app can edit the preselected values from the App GitHub 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.

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:

https://github.com/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

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

App GitHub configuration parameters

Name	Type	Description
`name`	`string`	The name of the App GitHub. 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 App GitHub.
`url`	`string`	The full URL of your App GitHub's website homepage.
`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.
`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 App GitHub 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 App GitHub is available to the public or `false` when it is only accessible to the owner of the app.
`webhook_url`	`string`	The full URL that you would like to send webhook event payloads to.
`webhook_secret`	`string`	You can specify a secret to secure your webhooks. See "Securing your webhooks" for more details.
`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 App GitHub. See the "App GitHub 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`.
`domain`	`string`	The URL of a content reference.
`single_file_name`	`string`	When you grant `read` or `write` access to the `single_file` permission, this field provides the path to the single file your App GitHub will manage.

App GitHub 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`.
`content_references`	Grants access to the "Create a content attachment" endpoint. 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 "Get an organization" 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 "Get a user" 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`.
`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 security alerts for vulnerable dependencies in a repository. See "About security alerts for vulnerable dependencies" to learn more. Can be one of: `none` or `read`.
`watching`	Grants access to list and change repositories a user is subscribed to. Can be one of: `none`, `read`, or `write`.

App GitHub 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` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "ejecuciones de verificación".
`check_suite`	`checks`	Ha ocurrido una actividad de suite de verificaciones. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "suites de verificaciones".
`commit_comment`	`contents`	Se creó un comentario de una confirmación. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "comentario de confirmación".
`content_reference`	`content_references`	Una referencia de contenido nueva se muestra como `created`. Se crea una referenci de contenido nueva cuando el cuerpo o el comentario de un informe de problemas o solicitud de extracción incluye un URL que empte con un dominio de referencia de contenido configurado. Para obtener más información, consulta la sección "Utilizar adjuntos de contenido" para aprender más sobre las referencias de contenido y sus adjuntos.
`create`	`contents`	Se crea una rama o etiqueta de Git. Para obtener más información, consulta la API de REST de "Datos de Git".
`delete`	`contents`	Se borra una rama o etiqueta de Git. Para obtener más información, consulta la API de REST de "Datos de Git".
`deployment`	`deployments`	Se crea un despliegue. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "despliegue".
`deployment_status`	`deployments`	Se crea un despliegue. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "estados de despliegue".
`fork`	`contents`	Un usuario bifurca un repositorio. Para obtener más información, consulta la API de REST de "bifurcaciones".
`gollum`	`contents`	Se crea o actualiza una página de wiki. Para obtener más información, consulta la sección "Acerca de las wikis".
`issues`	`issues`	La actividar relacionada con un informe de problemas. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "informe de problemas".
`issue_comment`	`issues`	La actividad relacionada con el comentario de un informe de problemas. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "comentrios del informe de problemas".
`label`	`metadata`	La actividar relacionada con un informe de problemas. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "etiquetas".
`member`	`members`	La actividad relacionada con los colaboradores del repositorio. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "colaboradores".
`membership`	`members`	La actividad relacionada con la membrecía del equipo. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "miembros del equipo".
`milestone`	`pull_request`	La actividar relacionada con los hitos. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de 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` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "organizaciones".
`page_build`	`pages`	Representa un intento de creación de un sitio de GitHub Pages, ya sea que fuese exitoso o no. Una carga a una rama habilitada de GitHub Pages (`gh-pages` para páginas de proyecto, `master` para páginas de organización y de usuario) activa este evento.
`project`	`repository_projects` or `organization_projects`	La actividad relacionada con los tableros de proyecto. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "proyectos".
`project_card`	`repository_projects` or `organization_projects`	La actividad relacionada con las tarjetas de proyecto. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "tarjetas de proyecto".
`project_column`	`repository_projects` or `organization_projects`	La actividad relacionada con las columnas en un tablero de proyecto. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "columnas de proyecto".
`public`	`metadata`	Cuando un repositorio privado se hace público. Sin duda alguna: el mejor evento de GitHub Enterprise.
`pull_request`	`pull_requests`	La actividad relacionada con las solicitudes de extracción. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "solicitudes de extracción".
`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` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "revisiones de la solicitud de extracción".
`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` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "comentrios de revisión de la solicitud de extracción".
`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` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "lanzamientos".
`repository`	`metadata`	La actividad relacionada con un repositorio. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "repositorios".
`status`	`statuses`	Cuando el estado de una confirmación de Git cambia. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "estados".
`team`	`members`	La actividad relacionada con el equipo de una organización. El tipo de actividad se especifica en la propiedad `action` del objeto de la carga útil. Para obtener más información, consulta la API de 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` del objeto de la carga útil. Para obtener más información, consulta la API de REST de "marcar con una estrella".