OrganizationWebhook

This resource allows you to create and manage webhooks for GitHub organization.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = new Github.OrganizationWebhook("foo", new Github.OrganizationWebhookArgs
        {
            Active = false,
            Configuration = new Github.Inputs.OrganizationWebhookConfigurationArgs
            {
                ContentType = "form",
                InsecureSsl = false,
                Url = "https://google.de/",
            },
            Events = 
            {
                "issues",
            },
        });
    }

}

Coming soon!

import pulumi
import pulumi_github as github

foo = github.OrganizationWebhook("foo",
    active=False,
    configuration={
        "contentType": "form",
        "insecureSsl": False,
        "url": "https://google.de/",
    },
    events=["issues"])

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const foo = new github.OrganizationWebhook("foo", {
    active: false,
    configuration: {
        contentType: "form",
        insecureSsl: false,
        url: "https://google.de/",
    },
    events: ["issues"],
});

Create a OrganizationWebhook Resource

new OrganizationWebhook(name: string, args: OrganizationWebhookArgs, opts?: CustomResourceOptions);

def OrganizationWebhook(resource_name, opts=None, active=None, configuration=None, events=None, __props__=None);

func NewOrganizationWebhook(ctx *Context, name string, args OrganizationWebhookArgs, opts ...ResourceOption) (*OrganizationWebhook, error)

public OrganizationWebhook(string name, OrganizationWebhookArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args OrganizationWebhookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args OrganizationWebhookArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OrganizationWebhookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

OrganizationWebhook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The OrganizationWebhook resource accepts the following input properties:

Events List<string>: A list of events which should trigger the webhook. See a list of available events
Active bool: Indicate of the webhook should receive events. Defaults to true.
Configuration OrganizationWebhookConfigurationArgs: key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.

Events []string: A list of events which should trigger the webhook. See a list of available events
Active bool: Indicate of the webhook should receive events. Defaults to true.
Configuration OrganizationWebhookConfiguration: key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.

events string[]: A list of events which should trigger the webhook. See a list of available events
active boolean: Indicate of the webhook should receive events. Defaults to true.
configuration OrganizationWebhookConfiguration: key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.

events List[str]: A list of events which should trigger the webhook. See a list of available events
active bool: Indicate of the webhook should receive events. Defaults to true.
configuration Dict[OrganizationWebhookConfiguration]: key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.

Outputs

All input properties are implicitly available as output properties. Additionally, the OrganizationWebhook resource produces the following output properties:

Etag string
Id string: The provider-assigned unique ID for this managed resource.
Url string: URL of the webhook

Etag string
Id string: The provider-assigned unique ID for this managed resource.
Url string: URL of the webhook

etag string
id string: The provider-assigned unique ID for this managed resource.
url string: URL of the webhook

etag str
id str: The provider-assigned unique ID for this managed resource.
url str: URL of the webhook

Look up an Existing OrganizationWebhook Resource

Get an existing OrganizationWebhook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OrganizationWebhookState, opts?: CustomResourceOptions): OrganizationWebhook

static get(resource_name, id, opts=None, active=None, configuration=None, etag=None, events=None, url=None, __props__=None);

func GetOrganizationWebhook(ctx *Context, name string, id IDInput, state *OrganizationWebhookState, opts ...ResourceOption) (*OrganizationWebhook, error)

public static OrganizationWebhook Get(string name, Input<string> id, OrganizationWebhookState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Active bool: Indicate of the webhook should receive events. Defaults to true.
Configuration OrganizationWebhookConfigurationArgs: key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.
Etag string
Events List<string>: A list of events which should trigger the webhook. See a list of available events
Url string: URL of the webhook

Active bool: Indicate of the webhook should receive events. Defaults to true.
Configuration OrganizationWebhookConfiguration: key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.
Etag string
Events []string: A list of events which should trigger the webhook. See a list of available events
Url string: URL of the webhook

active boolean: Indicate of the webhook should receive events. Defaults to true.
configuration OrganizationWebhookConfiguration: key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.
etag string
events string[]: A list of events which should trigger the webhook. See a list of available events
url string: URL of the webhook

active bool: Indicate of the webhook should receive events. Defaults to true.
configuration Dict[OrganizationWebhookConfiguration]: key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.
etag str
events List[str]: A list of events which should trigger the webhook. See a list of available events
url str: URL of the webhook

Supporting Types

OrganizationWebhookConfiguration

See the input and output API doc for this type.

Url string: URL of the webhook
ContentType string
InsecureSsl bool
Secret string

Url string: URL of the webhook
ContentType string
InsecureSsl bool
Secret string

url string: URL of the webhook
contentType string
insecureSsl boolean
secret string

url str: URL of the webhook
contentType str
insecureSsl bool
secret str

Package Details

Repository: https://github.com/pulumi/pulumi-github
License: Apache-2.0
Notes: This Pulumi package is based on the github Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud