Skip to content
Available onCommunityCloudPro

GitHub WebHook Integration

Collect GitHub events (via webhooks), transform them to cdevents.

  • Github tracks all changes to repositories, issues, pull requests, releases, workflows, and more. And it notifies a webhook about these changes.
  • cdviz-collector transforms these events to cdevents, and sends them to the database, listeners,...

From eventCDEvents
package.publishedartifact.published
release.publishedartifact.published
create (branch)branch.created
delete (branch)branch.deleted
pull_request.openedchange.created
pull_request.closedchange.{merged, abandoned}
pull_request.*change.updated
pull_request_review.submittedchange.reviewed
workflow_run.requestedpipelineRun.queued
workflow_run.in_progresspipelineRun.started
workflow_run.completedpipelineRun.finished
workflow_job.in_progresstaskRun.started
workflow_job.completedtaskRun.finished
issue.openedticket.created
issue.closedticket.closed
issue.*ticket.updated

Configuration ​

CDviz Side ​

Setting up cdviz-collector.toml to receive GitHub events involves defining a webhook source in the collector configuration file. Below is an example configuration snippet:

toml
# Remote transformers repository configuration
[remote.transformers-community]
type = "github://cdviz-dev/transformers-community"

[sources.github_webhook]
enabled = true
transformer_refs = ["github_events"]

[sources.github_webhook.extractor]
type = "webhook"
id = "000-github"
headers_to_keep = []

[sources.github_webhook.extractor.headers]
"x-hub-signature-256" = { type = "signature", signature_encoding = "hex", signature_on = "body", signature_prefix = "sha256="