github.github.definewebhook

Home > @runlightyear/github > GitHub > defineWebhook

GitHub.defineWebhook() method

Define a GitHub repository webhook

Signature:

static defineWebhook(props: DefineGitHubWebhookProps): string;

Parameters

Parameter	Type	Description
props	DefineGitHubWebhookProps

Returns:

string

Example

Subscribe to push events

GitHub.defineWebhook({
  name: "githubPushes",
  title: "GitHub Pushes",
  subscribeProps: () => {
    return {
      owner: "<owner>",
      repo: "<repo>",
      events: ["push"],
    }
  },
});