We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
Erfahre mehr über die einzelnen Ereignistypen, die auslösende Aktion auf GitHub und die besonderen Eigenschaften der einzelnen Ereignisse für die Issue-Ereignis-API und Zeitachsenereignis-API.
Issue-Ereignisse werden durch Aktivität in Issues und Pull Requests ausgelöst und sind in der Issue-Ereignis-API und der Zeitachsenereignis-API verfügbar. Jeder Ereignistyp gibt an, ob das Ereignis in der Issue-Ereignis-API oder in der Zeitachsenereignis-API verfügbar ist.
Die GitHub-REST-API betrachtet alle Pull Requests als Issue, doch nicht jedes Issue ist ein Pull Request. Aus diesem Grund können die Issue-Ereignis- und Zeitachsenereignisendpunkte sowohl Issues als auch Pull Requests in der Antwort zurückgeben. Pull Requests weisen im issue-Objekt eine pull_request-Eigenschaft auf. Da es sich bei Pull Requests um Issues handelt, treten bei Issue- und Pull Request-Nummern in einem Repository keine Überlappungen auf. Beispiel: Wenn du dein erstes Issue in einem Repository öffnest, lautet die Nummer 1. Öffne anschließend ein Pull Request, weist dieses die Nummer 2 auf. Jeder Ereignistyp gibt an, ob das Ereignis in Pull Requests, Issues oder beidem auftritt.
Gemeinsame Eigenschaften in Issue-Ereignisobjekten
Alle Issue-Ereignisse weisen dieselbe Objektstruktur auf. Die einzige Ausnahme sind Ereignisse, die ausschließlich in der Zeitachsenereignis-API verfügbar sind. Einige Ereignisse enthalten zudem zusätzliche Eigenschaften, die weiteren Kontext zu den Ereignisressourcen bieten. Einzelheiten zu Eigenschaften, die von diesem Objektformat abweichen, findest du im jeweiligen Ereignis.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
added_to_project
Das Issue oder der Pull Request wurde zu einem Projektboard hinzugefügt. Dieses Ereignis wird nur in Antworten angezeigt, wenn Projektboards im Repository aktiviert wurden.
Verfügbarkeit
Typ des Problems
Issue-Ereignis-API
Zeitachsenereignis-API
Probleme
Pull Request
X
X
Ereignisobjekteigenschaften
Hinweis: Projektkartendetails werden jetzt in REST-API-Antworten für projektbezogene Issue- und Zeitachsenereignisse angezeigt. Dieses Feature ist jetzt als Vorschauversion für Entwickler verfügbar. Ausführliche Informationen hierzu findest du in diesem Blogbeitrag.
Um das project_card-Attribut zu erhalten, müssen Projektboards für ein Repository aktiviert sein, und du musst einen benutzerdefinierten Medientyp im Accept-Header bereitstellen:
application/vnd.github.starfox-preview+json
Warnung: Die API kann sich während des Vorschauzeitraums ohne vorherige Ankündigung ändern. Vorschaufeatures werden für die Verwendung in der Produktion nicht unterstützt. Wenn Probleme auftreten, wende dich an your site administrator.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist. assignee
assigner
object
Die Person, die die Zuweisung für dieses Issue aufgehoben hat. Dieses Feld ist in der API für Issueereignisse, aber nicht in der API für Zeitachsenereignisse verfügbar.
automatic_base_change_failed
GitHub hat versucht, den Basisbranch des Pull Requests automatisch zu ändern, der Versuch war jedoch nicht erfolgreich.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
closed
Das Issue oder der Pull Request wurde geschlossen. Wenn commit_id vorhanden ist, gibt diese ID den Commit an, mit dem das Issue unter Verwendung der „closes/fixes“-Syntax geschlossen wurde. Weitere Informationen zu dieser Syntax findest du unter Linking a pull request to an issue („Verknüpfen eines Pull Requests mit einem Issue“).
Der Zeitstempel für den Zeitpunkt, zu dem der Kommentar hinzugefügt wurde.
updated_at
string
Der Zeitstempel für den Zeitpunkt, zu dem der Kommentar aktualisiert bzw. erstellt wurde (falls der Kommentar nicht aktualisiert wurde).
author_association
string
Die Berechtigungen der Benutzerin oder des Benutzers für das Repository des Issues. Wenn die oder der Besitzer*in des Repositorys einen Kommentar erstellt hat, lautet der Wert z. B. "OWNER".
body
string
Der Kommentartext.
event
string
Der Ereigniswert lautet "commented".
actor
object
Die Person, die das Ereignis generiert hat.
Commit wurde ausgeführt
Ein Commit wurde zum HEAD-Branch des Pull Requests hinzugefügt.
Die Person, die den Commit im Namen des Erstellers committet hat.
tree
object
Die Git-Struktur des Commits.
message
string
Die Commitnachricht.
parents
array of objects
Eine Liste mit übergeordneten Commits.
verification
object
Das Ergebnis der Signaturüberprüfung für den Commit. Weitere Informationen findest du unter Signature verification object („Signaturüberprüfungsobjekt“).
event
string
Der Ereigniswert lautet "committed".
connected
Das Issue oder der Pull Request wurde mit einem anderen Issue oder Pull Request verknüpft. Weitere Informationen findest du unter Linking a pull request to an issue („Verknüpfen eines Pull Requests mit einem Issue“).
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
converted_note_to_issue
Das Issue wurde erstellt, indem ein Hinweis in einem Projektboard in ein Issue konvertiert wurde. Dieses Ereignis wird nur in Antworten angezeigt, wenn Projektboards im Repository aktiviert wurden.
Verfügbarkeit
Typ des Problems
Issue-Ereignis-API
Zeitachsenereignis-API
Probleme
X
X
Ereignisobjekteigenschaften
Hinweis: Projektkartendetails werden jetzt in REST-API-Antworten für projektbezogene Issue- und Zeitachsenereignisse angezeigt. Dieses Feature ist jetzt als Vorschauversion für Entwickler verfügbar. Ausführliche Informationen hierzu findest du in diesem Blogbeitrag.
Um das project_card-Attribut zu erhalten, müssen Projektboards für ein Repository aktiviert sein, und du musst einen benutzerdefinierten Medientyp im Accept-Header bereitstellen:
application/vnd.github.starfox-preview+json
Warnung: Die API kann sich während des Vorschauzeitraums ohne vorherige Ankündigung ändern. Vorschaufeatures werden für die Verwendung in der Produktion nicht unterstützt. Wenn Probleme auftreten, wende dich an your site administrator.
Der Zeitstempel für den Zeitpunkt, zu dem der Querverweis hinzugefügt wurde.
updated_at
string
Der Zeitstempel für den Zeitpunkt, zu dem der Querverweis aktualisiert oder erstellt wurde (falls der Querverweis nicht aktualisiert wurde).
source
object
Das Issue oder der Pull Request, in dem ein Querverweis hinzugefügt wurde.
source[type]
string
Da Pull Requests den Typ „Issue“ aufweisen, lautet dieser Wert immer "issue". In der Zeitachsenereignis-API werden nur Querverweisereignisse zurückgegeben, die von Issues oder Pull Requests ausgelöst wurden. Wenn du feststellen möchtest, ob das Issue, das das Ereignis ausgelöst hat, ein Pull Request ist, kannst du überprüfen, ob das source[issue][pull_request]-Objekt vorhanden ist.
source[issue]
object
Das issue-Objekt, das den Querverweis hinzugefügt hat.
event
string
Der Ereigniswert lautet "cross-referenced".
demilestoned
Das Issue oder der Pull Request wurde aus einem Meilenstein entfernt.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
getrennt
Die Verknüpfung des Issues oder Pull Requests mit einem anderen Issue oder Pull Request wurde entfernt. Weitere Informationen findest du unter Linking a pull request to an issue („Verknüpfen eines Pull Requests mit einem Issue“).
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
marked_as_duplicate
Eine Benutzerin mit Schreibberechtigungen hat ein Issue als Duplikat eines anderen Issues bzw. einen Pull Request als Duplikat eines anderen Pull Requests markiert.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
Zusammengeführt
Der Pull Request wurde zusammengeführt. Das Attribut commit_id ist der SHA1 des HEAD-Commits, der zusammengeführt wurde. commit_repository stimmt immer mit dem Hauptrepository überein.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist. milestone
milestone[title]
string
Der Titel des Meilensteins.
moved_columns_in_project
Das Issue oder der Pull Request wurde innerhalb der Spalten eines Projektboards verschoben. Dieses Ereignis wird nur in Antworten angezeigt, wenn Projektboards im Repository aktiviert wurden.
Verfügbarkeit
Typ des Problems
Issue-Ereignis-API
Zeitachsenereignis-API
Probleme
Pull Requests
X
X
Ereignisobjekteigenschaften
Hinweis: Projektkartendetails werden jetzt in REST-API-Antworten für projektbezogene Issue- und Zeitachsenereignisse angezeigt. Dieses Feature ist jetzt als Vorschauversion für Entwickler verfügbar. Ausführliche Informationen hierzu findest du in diesem Blogbeitrag.
Um das project_card-Attribut zu erhalten, müssen Projektboards für ein Repository aktiviert sein, und du musst einen benutzerdefinierten Medientyp im Accept-Header bereitstellen:
application/vnd.github.starfox-preview+json
Warnung: Die API kann sich während des Vorschauzeitraums ohne vorherige Ankündigung ändern. Vorschaufeatures werden für die Verwendung in der Produktion nicht unterstützt. Wenn Probleme auftreten, wende dich an your site administrator.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
referenced
In einer Commitnachricht wurde auf das Issue verwiesen. Das Attribut commit_id ist der entsprechende Commit-SHA1, und commit_repository gibt an, wo dieser Commit gepusht wurde.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist.
removed_from_project
Das Issue oder der Pull Request wurde aus einem Projektboard entfernt. Dieses Ereignis wird nur in Antworten angezeigt, wenn Projektboards im Repository aktiviert wurden.
Verfügbarkeit
Typ des Problems
Issue-Ereignis-API
Zeitachsenereignis-API
Probleme
Pull Requests
X
X
Ereignisobjekteigenschaften
Hinweis: Projektkartendetails werden jetzt in REST-API-Antworten für projektbezogene Issue- und Zeitachsenereignisse angezeigt. Dieses Feature ist jetzt als Vorschauversion für Entwickler verfügbar. Ausführliche Informationen hierzu findest du in diesem Blogbeitrag.
Um das project_card-Attribut zu erhalten, müssen Projektboards für ein Repository aktiviert sein, und du musst einen benutzerdefinierten Medientyp im Accept-Header bereitstellen:
application/vnd.github.starfox-preview+json
Warnung: Die API kann sich während des Vorschauzeitraums ohne vorherige Ankündigung ändern. Vorschaufeatures werden für die Verwendung in der Produktion nicht unterstützt. Wenn Probleme auftreten, wende dich an your site administrator.
Der SHA des letzten Commits im Pull Request zum Zeitpunkt des Reviews.
submitted_at
string
Der Zeitstempel für den Zeitpunkt, zu dem der Review übermittelt wurde.
state
string
Der Status des übermittelten Reviews. Mögliche Werte: commented, changes_requested oder approved.
html_url
string
Die HTML-URL des Reviews.
pull_request_url
string
Die REST-API-URL zum Abrufen des Pull Requests.
author_association
string
Die Berechtigungen der Benutzerin oder des Benutzers für das Repository des Issues. Wenn die oder der Besitzer*in des Repositorys einen Kommentar erstellt hat, lautet der Wert z. B. "OWNER".
_links
object
html_url und pull_request_url.
event
string
Der Ereigniswert lautet "reviewed".
subscribed
Jemand hat Benachrichtigungen zu einem Issue oder Pull Request abonniert.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist. assignee
assigner
object
Die Person, die die Zuweisung für dieses Issue aufgehoben hat. Dieses Feld ist in der API für Issueereignisse, aber nicht in der API für Zeitachsenereignisse verfügbar.
Gibt den tatsächlichen Ereignistyp an, der aufgetreten ist.
commit_id
string
Der SHA des Commits, der sich auf dieses Issue bezieht.
commit_url
string
Der GitHub-REST-API-Link zum Commit, der sich auf dieses Issue bezieht.
created_at
string
Der Zeitstempel, der angibt, wann das Ereignis aufgetreten ist. lock_reason
unmarked_as_duplicate
Ein Issue oder Pull Request, das bzw. der zuvor als Duplikat eines anderen Issues oder Pull Requests markiert wurde, wird nicht mehr als Duplikat betrachtet.