1. Packages
  2. GitHub
  3. API Docs
  4. getOrganizationWebhooks
GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi

github.getOrganizationWebhooks

Explore with Pulumi AI

github logo
GitHub v6.1.0 published on Monday, Mar 11, 2024 by Pulumi

    Use this data source to retrieve all webhooks of the organization.

    Example Usage

    To retrieve all webhooks of the organization:

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const all = github.getOrganizationWebhooks({});
    
    import pulumi
    import pulumi_github as github
    
    all = github.get_organization_webhooks()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := github.GetOrganizationWebhooks(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Github = Pulumi.Github;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Github.GetOrganizationWebhooks.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.GithubFunctions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var all = GithubFunctions.getOrganizationWebhooks();
    
        }
    }
    
    variables:
      all:
        fn::invoke:
          Function: github:getOrganizationWebhooks
          Arguments: {}
    

    Using getOrganizationWebhooks

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOrganizationWebhooks(opts?: InvokeOptions): Promise<GetOrganizationWebhooksResult>
    function getOrganizationWebhooksOutput(opts?: InvokeOptions): Output<GetOrganizationWebhooksResult>
    def get_organization_webhooks(opts: Optional[InvokeOptions] = None) -> GetOrganizationWebhooksResult
    def get_organization_webhooks_output(opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationWebhooksResult]
    func GetOrganizationWebhooks(ctx *Context, opts ...InvokeOption) (*GetOrganizationWebhooksResult, error)
    func GetOrganizationWebhooksOutput(ctx *Context, opts ...InvokeOption) GetOrganizationWebhooksResultOutput

    > Note: This function is named GetOrganizationWebhooks in the Go SDK.

    public static class GetOrganizationWebhooks 
    {
        public static Task<GetOrganizationWebhooksResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetOrganizationWebhooksResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrganizationWebhooksResult> getOrganizationWebhooks(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: github:index/getOrganizationWebhooks:getOrganizationWebhooks
      arguments:
        # arguments dictionary

    getOrganizationWebhooks Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Webhooks List<GetOrganizationWebhooksWebhook>
    An Array of GitHub Webhooks. Each webhook block consists of the fields documented below.


    Id string
    The provider-assigned unique ID for this managed resource.
    Webhooks []GetOrganizationWebhooksWebhook
    An Array of GitHub Webhooks. Each webhook block consists of the fields documented below.


    id String
    The provider-assigned unique ID for this managed resource.
    webhooks List<GetOrganizationWebhooksWebhook>
    An Array of GitHub Webhooks. Each webhook block consists of the fields documented below.


    id string
    The provider-assigned unique ID for this managed resource.
    webhooks GetOrganizationWebhooksWebhook[]
    An Array of GitHub Webhooks. Each webhook block consists of the fields documented below.


    id str
    The provider-assigned unique ID for this managed resource.
    webhooks Sequence[GetOrganizationWebhooksWebhook]
    An Array of GitHub Webhooks. Each webhook block consists of the fields documented below.


    id String
    The provider-assigned unique ID for this managed resource.
    webhooks List<Property Map>
    An Array of GitHub Webhooks. Each webhook block consists of the fields documented below.


    Supporting Types

    GetOrganizationWebhooksWebhook

    Active bool
    true if the webhook is active.
    Id int
    the ID of the webhook.
    Name string
    the name of the webhook.
    Type string
    the type of the webhook.
    Url string
    the url of the webhook.
    Active bool
    true if the webhook is active.
    Id int
    the ID of the webhook.
    Name string
    the name of the webhook.
    Type string
    the type of the webhook.
    Url string
    the url of the webhook.
    active Boolean
    true if the webhook is active.
    id Integer
    the ID of the webhook.
    name String
    the name of the webhook.
    type String
    the type of the webhook.
    url String
    the url of the webhook.
    active boolean
    true if the webhook is active.
    id number
    the ID of the webhook.
    name string
    the name of the webhook.
    type string
    the type of the webhook.
    url string
    the url of the webhook.
    active bool
    true if the webhook is active.
    id int
    the ID of the webhook.
    name str
    the name of the webhook.
    type str
    the type of the webhook.
    url str
    the url of the webhook.
    active Boolean
    true if the webhook is active.
    id Number
    the ID of the webhook.
    name String
    the name of the webhook.
    type String
    the type of the webhook.
    url String
    the url of the webhook.

    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.1.0 published on Monday, Mar 11, 2024 by Pulumi