createGithubWebhookAction()

Home > @backstage/plugin-scaffolder-backend-module-github > createGithubWebhookAction

Creates new action that creates a webhook for a repository on GitHub.

Signature:

function createGithubWebhookAction(options: {
    integrations: ScmIntegrationRegistry;
    defaultWebhookSecret?: string;
    githubCredentialsProvider?: GithubCredentialsProvider;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    webhookUrl: string;
    webhookSecret?: string | undefined;
    events?: string[] | undefined;
    active?: boolean | undefined;
    contentType?: "form" | "json" | undefined;
    insecureSsl?: boolean | undefined;
    token?: string | undefined;
}, import("@backstage/types").JsonObject>;

Parameters

Parameter	Type	Description
options	{ integrations: ScmIntegrationRegistry; defaultWebhookSecret?: string; githubCredentialsProvider?: GithubCredentialsProvider; }

Returns:

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; webhookUrl: string; webhookSecret?: string | undefined; events?: string[] | undefined; active?: boolean | undefined; contentType?: "form" | "json" | undefined; insecureSsl?: boolean | undefined; token?: string | undefined; }, import("@backstage/types").JsonObject>

Parameters​

Parameters