Skip to main content

Erstellen einer GitHub-App mithilfe von URL-Parametern

Du kannst die Einstellungen einer neuen GitHub App mithilfe von URL-Abfrageparametern vorab auswählen, um die Konfiguration der neuen GitHub App schnell einzurichten.

Informationen zu GitHub App-URL-Parametern

Du kannst Abfrageparameter zu diesen URLs hinzufügen, um die Konfiguration einer GitHub App auf einem persönlichen oder Organisationskonto vorab auszuwählen:

  • Persönliches Konto: https://github.com/settings/apps/new
  • Organisationskonto: https://github.com/organizations/:org/settings/apps/new

Die Person, die die App erstellt, kann die vorab ausgewählten Werte von der GitHub App-Registrierungsseite bearbeiten, bevor sie die App übermittelt. Wenn du keine erforderlichen Parameter in die URL-Abfragezeichenfolge einschließt, z. B. name, muss die Person, die die App erstellt, einen Wert eingeben, bevor sie die App übermittelt.

Für Apps, die ein Geheimnis zum Sichern ihres Webhooks benötigen, muss der Wert des Geheimnisses durch die Person, die die App erstellt, und nicht mithilfe von Abfrageparametern im Formular festgelegt werden. Weitere Informationen findest du unter Sichern deiner Webhooks.

Die folgende URL erstellt eine neue öffentliche App namens octocat-github-app mit einer vorkonfigurierten Beschreibung und Rückruf-URL. Diese URL wählt auch Lese- und Schreibberechtigungen für checks, abonniert die Webhook-Ereignisse check_run und check_suite und wählt die Option zum Anfordern der Benutzerautorisierung (OAuth) während der Installation aus:

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

Die vollständige Liste der verfügbaren Abfrageparameter, Berechtigungen und Ereignisse wird in den folgenden Abschnitten aufgeführt.

GitHub App-Konfigurationsparameter

NametypeBESCHREIBUNG
namestringDer Name der GitHub App. Gib deiner App einen klaren und kurzen Namen. Deine App kann nicht denselben Namen wie ein vorhandener GitHub-Benutzer haben, es sei denn, es handelt sich um deinen eigenen Benutzer- oder Organisationsnamen. Eine Slugversion des Namens deiner App wird in der Benutzeroberfläche angezeigt, wenn deine Integration eine Aktion ausführt.
descriptionstringEine Beschreibung der GitHub App.
urlstringDie vollständige URL der Startseite der Website deiner GitHub App.
callback_urlsarray of stringsVollständige URL, an die Benutzer*innen nach der Autorisierung einer Installation umgeleitet werden. Du kannst bis zu zehn Rückruf-URLs bereitstellen. Diese URLs werden verwendet, wenn deine App Benutzer-zu-Server-Anforderungen identifizieren und autorisieren muss. Beispiel: callback_urls[]=https://example.com&callback_urls[]=https://example-2.com.
request_oauth_on_installbooleanWenn deine App Benutzer mit dem OAuth-Flow autorisiert, kannst du diese Option auf true festlegen, damit Personen die App während der Installation autorisieren können, was einen Schritt einspart. Wenn du diese Option auswählst, ist die setup_url nicht mehr verfügbar, und Benutzer werden nach der Installation der App an deine callback_url weitergeleitet.
setup_urlstringDie vollständige URL zum Umleiten nach der Installation der GitHub App, wenn die App nach der Installation ein zusätzliches Setup erfordert.
setup_on_updatebooleanLege diesen Parameter auf true fest, um Personen an die Setup-URL umzuleiten, wenn Installationen aktualisiert wurden, z. B. nach dem Hinzufügen oder Entfernen von Repositorys.
publicbooleanLege diesen Parameter auf true fest, wenn deine GitHub App öffentlich verfügbar sein soll, oder auf false, wenn nur der Besitzer der App darauf zugreifen darf.
webhook_activebooleanLege diesen Parameter auf false fest, um den Webhook zu deaktivieren. Der Webhook ist standardmäßig aktiviert.
webhook_urlstringDie vollständige URL, an die du Webhook-Ereignisnutzdaten senden möchtest.
eventsarray of stringsWebhook-Ereignisse. Einige Webhook-Ereignisse erfordern read- oder write-Berechtigungen für eine Ressource, bevor du das Ereignis auswählen kannst, wenn du eine neue GitHub App registrierst. Verfügbare Ereignisse und deren erforderliche Berechtigungen findest du im Abschnitt GitHub App-Webhook-Ereignisse. Du kannst mehrere Ereignisse in einer Abfragezeichenfolge auswählen. Beispiel: events[]=public&events[]=label.
single_file_namestringDies ist eine stark begrenzte Berechtigung, mit der die App auf eine einzelne Datei in einem beliebigen Repository zugreifen kann. Wenn du die single_file-Berechtigung auf read oder write festlegst, stellt dieses Feld den Pfad zur einzelnen Datei bereit, die deine GitHub App verwaltet. Wenn du mehrere Dateien verwalten musst, lies unten single_file_paths.
single_file_pathsarray of stringsDadurch kann die App auf bis zu zehn angegebene Dateien in einem Repository zugreifen. Wenn du die single_file-Berechtigung auf read oder write festlegst, kann dieses Array die Pfade für bis zu zehn Dateien speichern, die deine GitHub App verwaltet. Diese Dateien erhalten alle die gleiche Berechtigung, die von single_file festgelegt ist, und verfügen nicht über separate individuelle Berechtigungen. Wenn zwei oder mehr Dateien konfiguriert sind, gibt die API multiple_single_files=true zurück, anderenfalls multiple_single_files=false.

GitHub App-Berechtigungen

Du kannst Berechtigungen in einer Abfragezeichenfolge mithilfe des Berechtigungsnamens in der folgenden Tabelle als Abfrageparameternamen und den Berechtigungstyp als Abfragewert auswählen. Wenn du beispielsweise Read & write-Berechtigungen in der Benutzeroberfläche für contents auswählen möchtest, würde deine Abfragezeichenfolge &contents=write enthalten. Für die Auswahl von Read-only-Berechtigungen auf der Benutzeroberfläche von blocking würde deine Abfragezeichenfolge &blocking=read enthalten. Für die Auswahl von no-access auf der Benutzeroberfläche von checks würde deine Abfragezeichenfolge die checks-Berechtigung nicht enthalten.

BerechtigungBESCHREIBUNG
administrationGewährt Zugriff auf verschiedene Endpunkte für die Organisations- und Repositoryverwaltung. Kann none, read oder write sein.
blockingGewährt Zugriff auf die API zum Blockieren von Benutzern. Kann none, read oder write sein.
checksGewährt Zugriff auf die API für Überprüfungen. Kann none, read oder write sein.
contentsGewährt Zugriff auf verschiedene Endpunkte, mit denen du Repositoryinhalte ändern kannst. Kann none, read oder write sein.
deploymentsGewährt Zugriff auf die Bereitstellungs-API. Kann none, read oder write sein.
emailsGewährt Zugriff auf die E-Mail-API. Kann none, read oder write sein.
followersGewährt Zugriff auf die Follower-API. Kann none, read oder write sein.
gpg_keysGewährt Zugriff auf die GPG-Schlüssel-API. Kann none, read oder write sein.
issuesGewährt Zugriff auf die Issue-API. Kann none, read oder write sein.
keysGewährt Zugriff auf die API für öffentliche Schlüssel. Kann none, read oder write sein.
membersGewährt Zugriff zum Verwalten der Mitglieder einer Organisation. Kann none, read oder write sein.
metadataGewährt Zugriff auf schreibgeschützte Endpunkte, die keine vertraulichen Daten offenlegen. Kann read oder none sein. Der Standardwert ist read, wenn du eine Berechtigung festlegst, oder none, wenn du keine Berechtigungen für die GitHub App festlegst.
organization_administrationGewährt Zugriff auf den Endpunkt Organisation aktualisieren und die API für Interaktionseinschränkungen für eine Organisation. Kann none, read oder write sein.
organization_hooksGewährt Zugriff auf die Organisationswebhook-API. Kann none, read oder write sein.
organization_planGewährt Zugriff zum Abrufen von Informationen über den Plan einer Organisation mithilfe des Endpunkts Organisation abrufen. Kann none oder read sein.
organization_projectsGewährt Zugriff auf die Projekt-API. Kann none, read, write oder admin sein.
organization_user_blockingGewährt Zugriff auf die API zum Blockieren von Organisationsbenutzern. Kann none, read oder write sein.
pagesGewährt Zugriff auf die Seiten-API. Kann none, read oder write sein.
planGewährt Zugriff zum Abrufen von Informationen über den GitHub-Plan eines Benutzers mithilfe des Endpunkts Benutzer abrufen. Kann none oder read sein.
pull_requestsGewährt Zugriff auf verschiedene Pull Request-Endpunkte. Kann none, read oder write sein.
repository_hooksGewährt Zugriff auf die Repository-Webhooks-API. Kann none, read oder write sein.
repository_projectsGewährt Zugriff auf die Projekt-API. Kann none, read, write oder admin sein.
secret_scanning_alertsGewährt Zugriff auf die API zur Überprüfung von Geheimnissen. Kann none, read oder write sein.
security_eventsGewährt Zugriff auf die API zur Codeüberprüfung. Kann none, read oder write sein.
single_fileGewährt Zugriff auf die Inhalts-API. Kann none, read oder write sein.
starringGewährt Zugriff auf die API zum Versehen mit einem Stern. Kann none, read oder write sein.
statusesGewährt Zugriff auf die Status-API. Kann none, read oder write sein.
team_discussionsGewährt Zugriff auf die Teamdiskussions-API und die Teamdiskussionskommentar-API. Mögliche Werte: none, read oder write.
vulnerability_alertsGewährt den Zugriff für den Empfang von Dependabot alerts in einem Repository Weitere Informationen findest du unter Informationen zu Dependabot alerts. Kann none oder read sein.
watchingGewährt Zugriff zum Auflisten und Ändern von Repositorys, die ein Benutzer abonniert hat. Kann none, read oder write sein.

GitHub App-Webhook-Ereignisse

Name von Webhook-EreignisErforderliche BerechtigungBESCHREIBUNG
check_runchecksDie Ausführungsaktivität wurde überprüft. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Überprüfungsausführungen.
check_suitechecksPrüfsuitenaktivität ist aufgetreten. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Prüfsuiten.
commit_commentcontentsEin Commitkommentar wird erstellt. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der Commitkommentar-REST-API.
createcontentsEin Git-Branch oder -Tag wird erstellt. Weitere Informationen findest du in der REST-API für die Git-Datenbank.
deletecontentsEin Git-Branch oder -Tag wird gelöscht. Weitere Informationen findest du in der REST-API für die Git-Datenbank.
deploymentdeploymentsEine Bereitstellung wird erstellt. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für „Bereitstellungen“.
deployment_statusdeploymentsEine Bereitstellung wird erstellt. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Bereitstellungen.
forkcontentsEin Benutzer forkt ein Repository. Weitere Informationen findest du in der „Forks“ REST-API.
gollumcontentsEine Wiki-Seite wird erstellt oder aktualisiert. Weitere Informationen findest du unter Informationen zu Wikis.
issuesissuesAktivität im Zusammenhang mit einem Issue. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Issues.
issue_commentissuesAktivitäten im Zusammenhang mit einem Issue oder einem Pull Request-Kommentar. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Issuekommentare.
labelmetadataAktivitäten im Zusammenhang mit einer Bezeichnung. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Bezeichnungen.
membermembersAktivitäten im Zusammenhang mit Repositorymitarbeitern. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Mitarbeiter.
membershipmembersAktivitäten im Zusammenhang mit der Teammitgliedschaft. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Teammitglieder.
milestonepull_requestAktivitäten im Zusammenhang mit Meilensteinen. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Meilensteine.
org_blockorganization_administrationAktivitäten im Zusammenhang mit Personen, die in einer Organisation blockiert werden. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API zum Blockieren von Organisationsbenutzern.
organizationmembersAktivitäten im Zusammenhang mit einer Organisation und ihren Mitgliedern. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Organisationen.
page_buildpagesStellt einen versuchten Build einer GitHub Pages-Website dar, unabhängig davon, ob er erfolgreich war. Ein Push an einen GitHub Pages-fähigen Branch (gh-pages für Projektseiten, den Standardbranch für Benutzer- und Organisationsseiten) löst dieses Ereignis aus.
projectrepository_projects oder organization_projectsclassic projects bezogene Aktivität. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Projekte.
project_cardrepository_projects oder organization_projectsKartenbezogene Aktivitäten in einem classic project. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Projektkarten.
project_columnrepository_projects oder organization_projectsSpaltenbezogene Aktivitäten in einem classic project. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Projektspalten.
publicmetadataWenn ein privates Repository öffentlich gemacht wird. Ohne Zweifel das beste GitHub Enterprise Cloud-Ereignis.
pull_requestpull_requestsAktivitäten im Zusammenhang mit Pull Requests. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Pull Requests.
pull_request_reviewpull_requestAktivitäten im Zusammenhang mit Pull Request-Überprüfungen. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der Pull Request-Überprüfungen-REST-API.
pull_request_review_commentpull_requestAktivitäten im Zusammenhang mit Pull Request-Reviewkommentaren im Unified Diff des Pull Request. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Pull Request-Reviewkommentare.
pull_request_review_threadpull_requestAktivität im Zusammenhang mit einem Kommentarthread zu einem Pull Request, der als aufgelöst oder nicht gelöst markiert wurde Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben.
pushcontentsEin oder mehrere Commits werden in einen Repositorybranch oder ein Tag gepusht.
releasecontentsAktivität im Zusammenhang mit einem Release. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Releases.
repositorymetadataAktivitäten im Zusammenhang mit einem Repository. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Repositorys.
repository_dispatchcontentsErmöglicht Integratoren, mithilfe von GitHub Actions benutzerdefinierte Ereignisse auszulösen.
statusstatusesWenn sich der Status eines Git-Commits ändert. Weitere Informationen findest du in der Dokumentation zur Status-REST-API.
teammembersAktivitäten im Zusammenhang mit dem Team einer Organisation. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Teams.
team_addmembersWenn ein Repository einem Team hinzugefügt wird.
watchmetadataWenn jemand ein Repository mit einem Stern versieht. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Sterne.