Skip to main content

GitHub-Ereignistypen

Erfahre für die Ereignis-API von GitHub mehr über die einzelnen Ereignistypen, die auslösende Aktion für GitHub und die besonderen Eigenschaften jedes Ereignisses.

Die Ereignis-API kann verschiedene Typen von Ereignissen zurückgeben, die durch Aktivität auf GitHub ausgelöst werden. Die Ereignisantworten enthalten gemeinsame Eigenschaften, weisen jedoch ein eindeutiges payload-Objekt auf, das vom Ereignistyp bestimmt wird. Unter Gemeinsame Eigenschaften von Ereignisobjekten sind die Eigenschaften beschrieben, die alle Ereignisse aufweisen. Außerdem beschreibt jeder Ereignistyp die eindeutigen payload-Eigenschaften des jeweiligen Ereignisses.

Gemeinsame Eigenschaften von Ereignisobjekten

Die von den Ereignis-API-Endpunkten zurückgegebenen Ereignisobjekte weisen dieselbe Struktur auf.

Name des Ereignis-API-AttributsBESCHREIBUNG
idEindeutiger Bezeichner für das Ereignis.
typeArt des Ereignisses. Ereignisse verwenden PascalCase für den Namen.
actorDieDer Benutzerin, die*der das Ereignis ausgelöst hat.
actor.idDer eindeutige Bezeichner für den Akteur.
actor.loginDer Benutzername des Akteurs.
actor.display_loginDas spezifische Anzeigeformat des Benutzernamens.
actor.gravatar_idDer eindeutige Bezeichner des Gravatar-Profils für den Akteur.
actor.urlDie REST-API-URL, die zum Abrufen des Benutzerobjekts verwendet wird (einschließlich zusätzlicher Benutzerinformationen).
actor.avatar_urlDie URL des Profilbilds des Akteurs.
repositoryDas Repositoryobjekt, in dem das Ereignis aufgetreten ist.
repository.idDer eindeutige Bezeichner des Repositorys.
repository.nameDer Name des Repositorys, das den Besitzer- und Repositorynamen enthält. Beispiel: octocat/hello-world ist der Name des hello-world-Repositorys, das sich im Besitz des persönlichen octocat-Kontos befindet.
repository.urlDie REST-API-URL, die zum Abrufen des Repositoryobjekts verwendet wird (einschließlich zusätzlicher Repositoryinformationen).
payloadDas Ereignisnutzlastobjekt ist für den Ereignistyp eindeutig. Der nachfolgende Ereignistyp bezieht sich auf das Ereignis-API-Objekt payload.
publicOb das Ereignis für alle Benutzer sichtbar ist.
created_atDatum und Uhrzeit der Auslösung des Ereignisses. Formatierung gemäß ISO 8601.
orgDie vom Akteur gewählte Organisation, die die Aktion durchführt, die das Ereignis auslöst.
Die Eigenschaft wird nur dann im Ereignisobjekt angezeigt, wenn sie zutrifft.
org.idDer eindeutige Bezeichner der Organisation.
org.loginDer Name der Organisation.
org.gravatar_idDer eindeutige Bezeichner des Gravatar-Profils der Organisation.
org.urlDie REST-API-URL zum Abrufen des Organisationsobjekts (einschließlich zusätzlicher Organisationsinformationen).
org.avatar_urlDie URL des Profilbilds der Organisation.

Beispiel für ein WatchEvent-Ereignisobjekt

Dieses Beispiel zeigt das Format der WatchEvent-Antwort bei Verwendung der Ereignis-API.

HTTP/2 200
Link: <https://api.github.com/resource?page=2>; rel="next",
      <https://api.github.com/resource?page=5>; rel="last"
[
  {
    "type": "WatchEvent",
    "public": false,
    "payload": {
    },
    "repository": {
      "id": 3,
      "name": "octocat/Hello-World",
      "url": "https://api.github.com/repos/octocat/Hello-World"
    },
    "actor": {
      "id": 1,
      "login": "octocat",
      "gravatar_id": "",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "url": "https://api.github.com/users/octocat"
    },
    "org": {
      "id": 1,
      "login": "github",
      "gravatar_id": "",
      "url": "https://api.github.com/orgs/github",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif"
    },
    "created_at": "2011-09-06T17:26:27Z",
    "id": "12345"
  }
]

CommitCommentEvent

Ein Commitkommentar wird erstellt. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der Commitkommentar-REST-API.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
actionstringDie ausgeführte Aktion. Kann created sein.
commentobjectDie Commitkommentarressource.

CreateEvent

Ein Git-Branch oder -Tag wird erstellt. Weitere Informationen findest du in der REST-API für die Git-Datenbank.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsseltypeBESCHREIBUNG
refstringDie Ressource git ref.
ref_typestringDer Typ des Git-Ref-Objekts, das im Repository erstellt wurde. Kann entweder branch oder tag sein.
master_branchstringDer Name des Standardbranchs des Repositorys (normalerweise main).
descriptionstringDie aktuelle Beschreibung des Repositorys.

DeleteEvent

Ein Git-Branch oder -Tag wird gelöscht. Weitere Informationen findest du in der REST-API für die Git-Datenbank.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
refstringDie Ressource git ref.
ref_typestringDer Typ des Git-Objekts „ref“, das im Repository gelöscht wurde. Kann entweder branch oder tag sein.

ForkEvent

Ein Benutzer forkt ein Repository. Weitere Informationen findest du in der „Forks“ REST-API.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
forkeeobjectDie erstellte repository-Ressource.

GollumEvent

Eine Wiki-Seite wird erstellt oder aktualisiert. Weitere Informationen findest du unter Informationen zu Wikis.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
pagesarrayDie Seiten, die aktualisiert wurden.
pages[][page_name]stringDer Name der Seite.
pages[][title]stringDer aktuelle Seitentitel.
pages[][action]stringDie Aktion, die auf der Seite ausgeführt wurde. Kann created oder edited sein.
pages[][sha]stringDas neueste Commit-SHA der Seite.
pages[][html_url]stringVerweist auf die HTML-Wiki-Seite.

IssueCommentEvent

Aktivitä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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsseltypeBESCHREIBUNG
actionstringDie Aktion, die für den Kommentar ausgeführt wurde. Kann created, edited oder deleted sein. changes
changes[body][from]stringDie vorherige Version des Texts, wenn die Aktion edited war.
issueobjectDas Issue, zu dem der Kommentar gehört.
commentobjectDer Kommentar selbst.

IssuesEvent

Aktivitä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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
actionstringDie durchgeführte Aktion. Dies kann opened, edited, closed, reopened, assigned, unassigned, labeled oder unlabeled sein. issue
changesobjectDie Änderungen am Issue, wenn die Aktion edited war.
changes[title][from]stringDie vorherige Version des Titels, wenn die Aktion edited war.
changes[body][from]stringDie vorherige Version des Texts, wenn die Aktion edited war.
assigneeobjectDer optionale Benutzer, der dem Problem zugewiesen oder dessen Zuweisung aufgehoben wurde.
labelobjectDie optionale Bezeichnung, die dem Problem hinzugefügt oder daraus entfernt wurde.

MemberEvent

Aktivitä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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
actionstringDie durchgeführte Aktion. Kann added lauten, um darauf hinzuweisen, dass ein Benutzer eine Einladung zu einem Repository akzeptiert hat. member
changesobjectDie Änderungen an den Berechtigungen der mitarbeitenden Person, wenn die Aktion edited war.
changes[old_permission][from]stringDie vorherigen Berechtigungen der mitarbeitenden Person, wenn die Aktion edited war.

PublicEvent

Wenn ein privates Repository öffentlich gemacht wird. Ohne Zweifel das beste GitHub Enterprise Server-Ereignis.

payload-Ereignisobjekt

Dieses Ereignis gibt ein leeres payload-Objekt zurück.

PullRequestEvent

Aktivitä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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsseltypeBESCHREIBUNG
actionstringDie durchgeführte Aktion. Mögliche Werte: opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled und synchronize. number
changesobjectDie Änderungen am Kommentar, wenn die Aktion edited war.
changes[title][from]stringDie vorherige Version des Titels, wenn die Aktion edited war.
changes[body][from]stringDie vorherige Version des Texts, wenn die Aktion edited war.
pull_requestobjectDer Pull Request selbst.

PullRequestReviewEvent

Aktivitä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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
actionstringDie durchgeführte Aktion. Kann created sein.
pull_requestobjectDer Pull Request, auf den sich das Review bezieht.
reviewobjectDas betroffene Review.

PullRequestReviewCommentEvent

Aktivitä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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsseltypeBESCHREIBUNG
actionstringDie Aktion, die für den Kommentar ausgeführt wurde. Kann created sein. changes
changes[body][from]stringDie vorherige Version des Texts, wenn die Aktion edited war.
pull_requestobjectDer Pull Request, zu dem der Kommentar gehört.
commentobjectDer Kommentar selbst.

PullRequestReviewThreadEvent

Aktivitä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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsseltypeBESCHREIBUNG
actionstringDie durchgeführte Aktion. Kann eine der folgenden Aktionen sein:
  • resolved: Ein Kommentarthread zu einem Pull Request wurde als gelöst markiert.
  • unresolved: Ein zuvor gelöster Kommentarthread zu einem Pull Request wurde als nicht gelöst markiert.
pull_requestobjectDer Pull Request, zu dem der Thread gehört
threadobjectDer betroffene Thread

PushEvent

Ein oder mehrere Commits werden in einen Repositorybranch oder ein Tag gepusht.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
push_idintegerDer eindeutige Bezeichner für den Push.
sizeintegerDie Anzahl von Commits im Push.
distinct_sizeintegerDie Anzahl von unterschiedlichen Commits im Push.
refstringDie ganze git ref, die verschoben wurde. Beispiel: refs/heads/main.
headstringDer SHA des letzten Commits in ref nach dem Push.
beforestringDer SHA des letzten Commits in ref vor dem Push.
commitsarrayEin Array von Commitobjekten, das die gepushten Commits beschreibt. (Das Array umfasst maximal 20 Commits. Bei Bedarf kann die Commits-API verwendet werden, um zusätzliche Commits abzurufen. Dieser Grenzwert wird ausschließlich auf Zeitachsenereignisse und nicht auf Webhook-Übermittlungen angewendet.)
commits[][sha]stringDer SHA des Commits.
commits[][message]stringDie Commitnachricht.
commits[][author]objectDer Git-Autor des Commits.
commits[][author][name]stringDer Name des Git-Autors.
commits[][author][email]stringDie E-Mail-Adresse des Git-Autors.
commits[][url]urlURL, die auf die Commit-API-Ressource verweist.
commits[][distinct]booleanGibt an, ob sich dieser Commit von einem zuvor gepushten Commit unterscheidet.

ReleaseEvent

Aktivitä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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsselTypBESCHREIBUNG
actionstringDie durchgeführte Aktion. Kann published sein. changes[body][from]
changes[name][from]stringDie vorherige Version des Namens, wenn die Aktion edited war.
releaseobjectDas release-Objekt.

WatchEvent

Wenn 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.

Das Ereignisobjekt enthält Eigenschaften, die für alle Ereignisse verwendet werden. Jedes Ereignisobjekt enthält die payload-Eigenschaft, und der Wert ist für jeden Ereignistyp eindeutig. Das payload-Objekt für dieses Ereignis wird weiter unten beschrieben.

payload-Ereignisobjekt

SchlüsseltypeBESCHREIBUNG
actionstringDie durchgeführte Aktion. Derzeit ist nur started möglich.