New Webhook Event (Instant)

import common from "../common/common-webhook.mjs"; import constants from "../common/constants.mjs"; import { getRelevantHeaders } from "../common/utils.mjs"; export default { ...common, key: "github-webhook-events", name: "New Webhook Event (Instant)", description: "Emit new event for each selected event type", type: "source", version: "1.0.5", props: { docsInfo: { type: "alert", alertType: "info", content: "[See the GitHub documentation](https://docs.github.com/en/webhooks/webhook-events-and-payloads) for more information on available events.", }, ...common.props, events: { label: "Webhook Events", description: "The event types to be emitted", type: "string[]", options: constants.REPOSITORY_WEBHOOK_EVENTS, }, }, dedupe: "unique", methods: { ...common.methods, getWebhookEvents() { return this.events; }, }, async run(event) { const { headers, body, } = event; // skip initial response from Github if (body?.zen) { console.log(body.zen); return; } this.$emit({ ...getRelevantHeaders(headers), ...body, }, { id: headers["x-github-delivery"], summary: `New event ${headers["x-github-hook-installation-target-id"]} of type ${headers["x-github-hook-installation-target-type"]}`, ts: new Date(), }); }, async activate() { const isAdmin = await this.checkAdminPermission(); if (!isAdmin) { throw new Error("Webhooks are only supported on repos where you have admin access."); } await this.createWebhook(); }, };

Label	Prop	Type	Description
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Webhook Events	`events`	`string[]`	Select a value from the drop down menu:`{ "label": "Activity related to a branch protection rule", "value": "branch_protection_rule" }{ "label": "Check run activity has occurred", "value": "check_run" }{ "label": "Check suite activity has occurred", "value": "check_suite" }{ "label": "Activity related to code scanning alerts in a repository", "value": "code_scanning_alert" }{ "label": "A commit comment is created", "value": "commit_comment" }{ "label": "A Git branch or tag is created", "value": "create" }{ "label": "A Git branch or tag is deleted", "value": "delete" }{ "label": "A deploy key is added or removed from a repository", "value": "deploy_key" }{ "label": "A deployment is created", "value": "deployment_status" }{ "label": "Activity related to a discussion", "value": "discussion" }{ "label": "Activity related to a comment in a discussion", "value": "discussion_comment" }{ "label": "A user forks a repository", "value": "fork" }{ "label": "A wiki page is created or updated", "value": "gollum" }{ "label": "Activity related to an issue or pull request comment", "value": "issue_comment" }{ "label": "Activity related to an issue", "value": "issues" }{ "label": "Activity related to a label", "value": "label" }{ "label": "Activity related to repository collaborators", "value": "member" }{ "label": "The webhook this event is configured on was deleted", "value": "meta" }{ "label": "Activity related to milestones", "value": "milestone" }{ "label": "Activity related to GitHub Packages", "value": "package" }{ "label": "Activity on attempted build of a GitHub Pages site, whether successful or not", "value": "page_build" }{ "label": "Activity related to project boards", "value": "project" }{ "label": "Activity related to project cards", "value": "project_card" }{ "label": "Activity related to columns in a project board", "value": "project_column" }{ "label": "When a private repository is made public", "value": "public" }{ "label": "Activity related to pull requests", "value": "pull_request" }{ "label": "Activity related to pull request reviews", "value": "pull_request_review" }{ "label": "Activity related to pull request review comments in the pull request's unified diff", "value": "pull_request_review_comment" }{ "label": "Activity related to a comment thread on a pull request being marked as resolved or unresolved", "value": "pull_request_review_thread" }{ "label": "One or more commits are pushed to a repository branch or tag", "value": "push" }{ "label": "Activity related to a release", "value": "release" }{ "label": "Activity related to a repository", "value": "repository" }{ "label": "Activity related to a repository being imported to GitHub", "value": "repository_import" }{ "label": "Activity related to security vulnerability alerts in a repository", "value": "repository_vulnerability_alert" }{ "label": "Activity related to a repository being starred", "value": "star" }{ "label": "When the status of a Git commit changes", "value": "status" }{ "label": "When a repository is added to a team", "value": "team_add" }{ "label": "When someone stars a repository", "value": "watch" }{ "label": "A GitHub Actions workflow job has been queued, is in progress, or has been completed on a repository", "value": "workflow_job" }{ "label": "When a GitHub Actions workflow run is requested or completed", "value": "workflow_run" }`

Label

Prop

Type

Description

GitHub

github

app

This component uses the GitHub app.

Repository

repoFullname

string

Select a value from the drop down menu.

N/A

db

$.service.db

This component uses $.service.db to maintain state between executions.

N/A

http

$.interface.http

This component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.

Webhook Events

events

string[]

Select a value from the drop down menu:

{
  "label": "Activity related to a branch protection rule",
  "value": "branch_protection_rule"
}

{
  "label": "Check run activity has occurred",
  "value": "check_run"
}

{
  "label": "Check suite activity has occurred",
  "value": "check_suite"
}

{
  "label": "Activity related to code scanning alerts in a repository",
  "value": "code_scanning_alert"
}

{
  "label": "A commit comment is created",
  "value": "commit_comment"
}

{
  "label": "A Git branch or tag is created",
  "value": "create"
}

{
  "label": "A Git branch or tag is deleted",
  "value": "delete"
}

{
  "label": "A deploy key is added or removed from a repository",
  "value": "deploy_key"
}

{
  "label": "A deployment is created",
  "value": "deployment_status"
}

{
  "label": "Activity related to a discussion",
  "value": "discussion"
}

{
  "label": "Activity related to a comment in a discussion",
  "value": "discussion_comment"
}

{
  "label": "A user forks a repository",
  "value": "fork"
}

{
  "label": "A wiki page is created or updated",
  "value": "gollum"
}

{
  "label": "Activity related to an issue or pull request comment",
  "value": "issue_comment"
}

{
  "label": "Activity related to an issue",
  "value": "issues"
}

{
  "label": "Activity related to a label",
  "value": "label"
}

{
  "label": "Activity related to repository collaborators",
  "value": "member"
}

{
  "label": "The webhook this event is configured on was deleted",
  "value": "meta"
}

{
  "label": "Activity related to milestones",
  "value": "milestone"
}

{
  "label": "Activity related to GitHub Packages",
  "value": "package"
}

{
  "label": "Activity on attempted build of a GitHub Pages site, whether successful or not",
  "value": "page_build"
}

{
  "label": "Activity related to project boards",
  "value": "project"
}

{
  "label": "Activity related to project cards",
  "value": "project_card"
}

{
  "label": "Activity related to columns in a project board",
  "value": "project_column"
}

{
  "label": "When a private repository is made public",
  "value": "public"
}

{
  "label": "Activity related to pull requests",
  "value": "pull_request"
}

{
  "label": "Activity related to pull request reviews",
  "value": "pull_request_review"
}

{
  "label": "Activity related to pull request review comments in the pull request's unified diff",
  "value": "pull_request_review_comment"
}

{
  "label": "Activity related to a comment thread on a pull request being marked as resolved or unresolved",
  "value": "pull_request_review_thread"
}

{
  "label": "One or more commits are pushed to a repository branch or tag",
  "value": "push"
}

{
  "label": "Activity related to a release",
  "value": "release"
}

{
  "label": "Activity related to a repository",
  "value": "repository"
}

{
  "label": "Activity related to a repository being imported to GitHub",
  "value": "repository_import"
}

{
  "label": "Activity related to security vulnerability alerts in a repository",
  "value": "repository_vulnerability_alert"
}

{
  "label": "Activity related to a repository being starred",
  "value": "star"
}

{
  "label": "When the status of a Git commit changes",
  "value": "status"
}

{
  "label": "When a repository is added to a team",
  "value": "team_add"
}

{
  "label": "When someone stars a repository",
  "value": "watch"
}

{
  "label": "A GitHub Actions workflow job has been queued, is in progress, or has been completed on a repository",
  "value": "workflow_job"
}

{
  "label": "When a GitHub Actions workflow run is requested or completed",
  "value": "workflow_run"
}

More Ways to Use GitHub#

Triggers#

New Branch Created from the GitHub API

Emit new event when a branch is created.

Try it

New Card in Column (Classic Projects) from the GitHub API

Emit new event when a (classic) project card is created or moved to a specific column. For Projects V2 use New Issue with Status trigger. More information here

Try it

New Collaborator from the GitHub API

Emit new event when a collaborator is added

Try it

New Commit from the GitHub API

Emit new event when commits are pushed to a branch

Try it

New Commit Comment from the GitHub API

Emit new event when a commit comment is created

Try it