Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Github Provider
  3. API Docs
  4. OrganizationWebhook
GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-github

github.OrganizationWebhook

Explore with Pulumi AI

github logo
GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-github

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

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  foo:
    type: github:OrganizationWebhook
    properties:
      name: web
      configuration:
        url: https://google.de/
        contentType: form
        insecureSsl: false
      active: false
      events:
        - issues

    Create OrganizationWebhook Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrganizationWebhook(name: string, args: OrganizationWebhookArgs, opts?: CustomResourceOptions);
    @overload
def OrganizationWebhook(resource_name: str,
                        args: OrganizationWebhookArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def OrganizationWebhook(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        events: Optional[Sequence[str]] = None,
                        active: Optional[bool] = None,
                        configuration: Optional[OrganizationWebhookConfigurationArgs] = None)
    func NewOrganizationWebhook(ctx *Context, name string, args OrganizationWebhookArgs, opts ...ResourceOption) (*OrganizationWebhook, error)
    public OrganizationWebhook(string name, OrganizationWebhookArgs args, CustomResourceOptions? opts = null)
    public OrganizationWebhook(String name, OrganizationWebhookArgs args)
public OrganizationWebhook(String name, OrganizationWebhookArgs args, CustomResourceOptions options)

    type: github:OrganizationWebhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args OrganizationWebhookArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args OrganizationWebhookArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var organizationWebhookResource = new Github.OrganizationWebhook("organizationWebhookResource", new()
{
    Events = new[]
    {
        "string",
    },
    Active = false,
    Configuration = new Github.Inputs.OrganizationWebhookConfigurationArgs
    {
        Url = "string",
        ContentType = "string",
        InsecureSsl = false,
        Secret = "string",
    },
});

    example, err := github.NewOrganizationWebhook(ctx, "organizationWebhookResource", &github.OrganizationWebhookArgs{
	Events: pulumi.StringArray{
		pulumi.String("string"),
	},
	Active: pulumi.Bool(false),
	Configuration: &github.OrganizationWebhookConfigurationArgs{
		Url:         pulumi.String("string"),
		ContentType: pulumi.String("string"),
		InsecureSsl: pulumi.Bool(false),
		Secret:      pulumi.String("string"),
	},
})

    var organizationWebhookResource = new OrganizationWebhook("organizationWebhookResource", OrganizationWebhookArgs.builder()
    .events("string")
    .active(false)
    .configuration(OrganizationWebhookConfigurationArgs.builder()
        .url("string")
        .contentType("string")
        .insecureSsl(false)
        .secret("string")
        .build())
    .build());

    organization_webhook_resource = github.OrganizationWebhook("organizationWebhookResource",
    events=["string"],
    active=False,
    configuration={
        "url": "string",
        "content_type": "string",
        "insecure_ssl": False,
        "secret": "string",
    })

    const organizationWebhookResource = new github.OrganizationWebhook("organizationWebhookResource", {
    events: ["string"],
    active: false,
    configuration: {
        url: "string",
        contentType: "string",
        insecureSsl: false,
        secret: "string",
    },
});

    type: github:OrganizationWebhook
properties:
    active: false
    configuration:
        contentType: string
        insecureSsl: false
        secret: string
        url: string
    events:
        - string

    OrganizationWebhook Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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 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 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 List<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 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 Sequence[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 OrganizationWebhookConfigurationArgs
    key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.
    events List<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 Property Map
    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 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
    etag String
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    URL of the webhook

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        configuration: Optional[OrganizationWebhookConfigurationArgs] = None,
        etag: Optional[str] = None,
        events: Optional[Sequence[str]] = None,
        url: Optional[str] = None) -> OrganizationWebhook
    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)
    public static OrganizationWebhook get(String name, Output<String> id, OrganizationWebhookState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 OrganizationWebhookConfiguration
    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 OrganizationWebhookConfigurationArgs
    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 List<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 OrganizationWebhookConfigurationArgs
    key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.
    etag str
    events Sequence[str]
    A list of events which should trigger the webhook. See a list of available events
    url str
    URL of the webhook
    active Boolean
    Indicate of the webhook should receive events. Defaults to true.
    configuration Property Map
    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

    Supporting Types

    OrganizationWebhookConfiguration, OrganizationWebhookConfigurationArgs

    Url string
    URL of the webhook
    ContentType string
    The content type for the payload. Valid values are either 'form' or 'json'.
    InsecureSsl bool
    Insecure SSL boolean toggle. Defaults to 'false'.
    Secret string
    The shared secret for the webhook
    Url string
    URL of the webhook
    ContentType string
    The content type for the payload. Valid values are either 'form' or 'json'.
    InsecureSsl bool
    Insecure SSL boolean toggle. Defaults to 'false'.
    Secret string
    The shared secret for the webhook
    url String
    URL of the webhook
    contentType String
    The content type for the payload. Valid values are either 'form' or 'json'.
    insecureSsl Boolean
    Insecure SSL boolean toggle. Defaults to 'false'.
    secret String
    The shared secret for the webhook
    url string
    URL of the webhook
    contentType string
    The content type for the payload. Valid values are either 'form' or 'json'.
    insecureSsl boolean
    Insecure SSL boolean toggle. Defaults to 'false'.
    secret string
    The shared secret for the webhook
    url str
    URL of the webhook
    content_type str
    The content type for the payload. Valid values are either 'form' or 'json'.
    insecure_ssl bool
    Insecure SSL boolean toggle. Defaults to 'false'.
    secret str
    The shared secret for the webhook
    url String
    URL of the webhook
    contentType String
    The content type for the payload. Valid values are either 'form' or 'json'.
    insecureSsl Boolean
    Insecure SSL boolean toggle. Defaults to 'false'.
    secret String
    The shared secret for the webhook

    Import

    Organization webhooks can be imported using the id of the webhook. The id of the webhook can be found in the URL of the webhook. For example, "https://github.com/organizations/foo-org/settings/hooks/123456789".

    $ pulumi import github:index/organizationWebhook:OrganizationWebhook terraform 123456789

    If secret is populated in the webhook’s configuration, the value will be imported as “********”.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi
    pulumi/pulumi-github