{ "componentChunkName": "component---src-templates-plugin-docs-tsx", "path": "/plugins/scm-webhook-plugin/docs/3.2.x/en/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":["en","de"]}]},"navigation":{"nodes":[{"section":"First steps","entries":[{"frontmatter":{"title":"Configuration","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-webhook-plugin/docs/3.2.x/en/configuration/"}},{"frontmatter":{"title":"Permissions","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-webhook-plugin/docs/3.2.x/en/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":"

Configuration Form

\n

The SCM-Webhook-Plugin provides a global and a repository specific configuration. The global webhooks are executed for\nall repositories on the SCM-Manager instance.

\n

Other plugins may provide further kinds of webhooks. These will be described in the documentation of the providing plugin.\nThe webhook plugin itself only provides a simple webhook:

\n

To register a new webhook you can select between \"GET\", \"POST\", \"PUT\", and \"AUTO\". If you select \"AUTO\", normally a GET\nrequest will be sent to the given URL. Only if the webhook contains commit data, a POST request will be sent instead.\nThe URL must be set to the exact address where the requests should be sent to.

\n

By default, the webhooks are triggered an each repository push. If needed, a webhook can also be configured to be\ntriggered for each commit. In addition, you can configure that the commit data should be attached to the webhook request.

\n

\n \n \n

\n

Webhook URL Builder

\n

You can use context-sensitive fields in the webhook url. We currently provide two main context objects which can be accessed as following:

\n

Repository

\n

Example: example.com/${repository.namespace}/${repository.name}/${repository.type}\nFind all supported fields here.

\n

Commit / Changeset

\n

Commit and changeset are synonym and both can be used to access the same context.

\n

Example: example.com/trigger/${changeset.id}/${changeset.author.name}\nFind all supported fields here.

\n

Webhook Payload

\n

List of commits

\n

Example:

\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

Single commit

\n

Example:

\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":"Configuration Form The SCM-Webhook-Plugin provides a global and a repository specific configuration. The global webhooks are executed for\nall repositories on…","tableOfContents":"","frontmatter":{"title":"Configuration","subtitle":null,"description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-webhook-plugin","slug":"/plugins/scm-webhook-plugin/docs/3.2.x/en/configuration/","version":"3.2.x","latestVersion":"3.2.x","latestPageVersion":"3.2.x","language":"en","canonicalPath":"/plugins/scm-webhook-plugin/docs/latest/en/configuration/","latestRootPath":"/plugins/scm-webhook-plugin/docs/3.2.x/en/"}}, "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}