{ "componentChunkName": "component---src-templates-plugin-docs-tsx", "path": "/plugins/scm-webhook-plugin/docs/3.2.x/de/configuration/", "result": {"data":{"plugin":{"name":"scm-webhook-plugin","displayName":"Webhook","description":"Notifies a remote webserver whenever a repository is pushed to","author":"Cloudogu GmbH","documentation":[{"version":"3.2.x","languages":["de","en"]},{"version":"3.1.x","languages":["de","en"]},{"version":"3.0.x","languages":["de","en"]},{"version":"2.4.x","languages":["de","en"]},{"version":"2.3.x","languages":["de","en"]},{"version":"2.2.x","languages":["de","en"]},{"version":"2.1.x","languages":["de","en"]}]},"navigation":{"nodes":[{"section":"Erste Schritte","entries":[{"frontmatter":{"title":"Konfiguration","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-webhook-plugin/docs/3.2.x/de/configuration/"}},{"frontmatter":{"title":"Berechtigungen","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-webhook-plugin/docs/3.2.x/de/permissions/"}}]}]},"versions":{"group":[{"fieldValue":"2.1.x"},{"fieldValue":"2.2.x"},{"fieldValue":"2.3.x"},{"fieldValue":"2.4.x"},{"fieldValue":"3.0.x"},{"fieldValue":"3.1.x"},{"fieldValue":"3.2.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"

Konfigurationsmaske

\n

Es gibt eine globale und eine repository-spezifische Konfiguration für das Webhook-Plugin. Globale Webhooks werden für\nalle Repositories der SCM-Manager-Instanz ausgeführt.

\n

Es ist möglich, durch andere SCM-Manager-Plugins weitere Arten von Webhooks zu erstellen. Diese werden ggf. in diesen\nPlugins beschrieben. Das Webhook-Plugin an sich stellt nur einen einfachen Webhook zur Verfügung:

\n

Beim Registrieren eines solchen Webhooks kann man zwischen den Request-Typen \"GET\", \"POST\", \"PUT\" und \"AUTO\" wählen.\nWird \"AUTO\" gewählt, sendet der Webhook einen GET-Request an die angegebene URL,\nes sei denn, es werden die Commit Daten mit dem Request übermittelt. In diesem Fall sendet der Webhook einen POST-Request.\nIn das Feld für die URL muss der genaue Endpunkt eingetragen werden, an die der Webhook den Request senden soll.

\n

Im Standardfall wird ein Webhook pro Repository Push getriggert. Über eine Checkbox kann der Webhook aber auch pro Commit\nausgelöst werden. Die zweite Checkbox in der Konfiguration sorgt dafür, dass der Webhook die Commit Daten an den Request anhängt.

\n

\n \n \n

\n

Webhook URL Builder

\n

Innerhalb der Webhook URL können kontext-sensitive Felder über Platzhalter definiert werden. Die Verwendung wird in folgenden Beispielen demonstriert.

\n

Repository

\n

Beispiel: example.com/${repository.namespace}/${repository.name}/${repository.type}\nAlle unterstützten Kontext-Felder finden Sie hier.

\n

Commit / Changeset

\n

Commit und Changeset sind Synonyme und beide Begriffe verweisen auf dasselbe Kontext-Objekt.\nWird jeder Commit einzeln per Webhook verarbeitet, kann direkt auf das Commit Objekt zugegriffen werden.

\n

Beispiel: example.com/trigger/${changeset.id}/${changeset.author.name}\nAlle unterstützten Kontext-Felder finden Sie hier.

\n

Webhook Payload

\n

Liste von Commits

\n

Beispiel:

\n
{\n  \"changeset\": [\n    {\n      \"author\": {\n        \"mail\": \"scm-admin@scm-manager.org\",\n        \"name\": \"SCM Administrator\",\n        \"valid\": true\n      },\n      \"branches\": [\n        \"main\"\n      ],\n      \"date\": 1675686308000,\n      \"description\": \"My repo commit description\",\n      \"id\": \"4fa9832c50e0ac57183023a30195d0f11a9dc0ef\",\n      \"parents\": [\n        \"74fb9da82be3d878be25a3c1c70a69fcbd3c0d66\"\n      ],\n      \"tags\": null,\n      \"contributors\": [\n        {\n          \"type\": \"Committed-by\",\n          \"person\": {\n            \"mail\": \"noreply@scm-manager.org\",\n            \"name\": \"SCM-Manager\",\n            \"valid\": true\n          }\n        }\n      ],\n      \"signatures\": [\n        {\n          \"keyId\": \"0x1348937E258263F4\",\n          \"type\": \"gpg\",\n          \"status\": \"VERIFIED\",\n          \"owner\": {\n            \"empty\": false,\n            \"present\": true\n          },\n          \"contacts\": [\n            {\n              \"mail\": \"scm-admin@scm-manager.org\",\n              \"name\": \"SCM Administrator\",\n              \"valid\": true\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}
\n

Einzelner Commit

\n

Beispiel:

\n
{\n  \"author\": {\n    \"mail\": \"scm-admin@scm-manager.org\",\n    \"name\": \"SCM Administrator\",\n    \"valid\": true\n  },\n  \"branches\": [\n    \"main\"\n  ],\n  \"date\": 1675686490000,\n  \"description\": \"My commit desc\",\n  \"id\": \"73757af953dd6b66c48aeae51407a5296ba9f9fa\",\n  \"parents\": [\n    \"4fa9832c50e0ac57183023a30195d0f11a9dc0ef\"\n  ],\n  \"tags\": null,\n  \"contributors\": [\n    {\n      \"type\": \"Committed-by\",\n      \"person\": {\n        \"mail\": \"noreply@scm-manager.org\",\n        \"name\": \"SCM-Manager\",\n        \"valid\": true\n      }\n    }\n  ],\n  \"signatures\": [\n    {\n      \"keyId\": \"0x1348937E258263F4\",\n      \"type\": \"gpg\",\n      \"status\": \"VERIFIED\",\n      \"owner\": {\n        \"empty\": false,\n        \"present\": true\n      },\n      \"contacts\": [\n        {\n          \"mail\": \"scm-admin@scm-manager.org\",\n          \"name\": \"SCM Administrator\",\n          \"valid\": true\n        }\n      ]\n    }\n  ]\n}
","description":"Konfigurationsmaske Es gibt eine globale und eine repository-spezifische Konfiguration für das Webhook-Plugin. Globale Webhooks werden für\nalle Repositories der…","tableOfContents":"","frontmatter":{"title":"Konfiguration","subtitle":null,"description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-webhook-plugin","slug":"/plugins/scm-webhook-plugin/docs/3.2.x/de/configuration/","version":"3.2.x","latestVersion":"3.2.x","latestPageVersion":"3.2.x","language":"de","canonicalPath":"/plugins/scm-webhook-plugin/docs/latest/de/configuration/","latestRootPath":"/plugins/scm-webhook-plugin/docs/3.2.x/de/"}}, "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}