Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Gitlab Provider
  4. API Docs
  5. getGroupHook
Viewing docs for GitLab v10.1.1
published on Thursday, Jul 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

gitlab.getGroupHook

gitlab logo
Viewing docs for GitLab v10.1.1
published on Thursday, Jul 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

    The gitlab.GroupHook data source allows to retrieve details about a hook in a group.

    Upstream API: GitLab REST API docs

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    variables:
  example:
    fn::invoke:
      function: gitlab:getGroup
      arguments:
        id: foo/bar/baz
  exampleGetGroupHook:
    fn::invoke:
      function: gitlab:getGroupHook
      arguments:
        group: ${example.id}
        hookId: 1

    pulumi {
  required_providers {
    gitlab = {
      source = "pulumi/gitlab"
    }
  }
}

data "gitlab_getgroup" "example" {
  id = "foo/bar/baz"
}
data "gitlab_getgrouphook" "exampleGetGroupHook" {
  group   = data.gitlab_getgroup.example.id
  hook_id = 1
}

    Using getGroupHook

    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 getGroupHook(args: GetGroupHookArgs, opts?: InvokeOptions): Promise<GetGroupHookResult>
function getGroupHookOutput(args: GetGroupHookOutputArgs, opts?: InvokeOptions): Output<GetGroupHookResult>
    def get_group_hook(group: Optional[str] = None,
                   hook_id: Optional[int] = None,
                   opts: Optional[InvokeOptions] = None) -> GetGroupHookResult
def get_group_hook_output(group: pulumi.Input[Optional[str]] = None,
                   hook_id: pulumi.Input[Optional[int]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetGroupHookResult]
    func LookupGroupHook(ctx *Context, args *LookupGroupHookArgs, opts ...InvokeOption) (*LookupGroupHookResult, error)
func LookupGroupHookOutput(ctx *Context, args *LookupGroupHookOutputArgs, opts ...InvokeOption) LookupGroupHookResultOutput

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

    public static class GetGroupHook 
{
    public static Task<GetGroupHookResult> InvokeAsync(GetGroupHookArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupHookResult> Invoke(GetGroupHookInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupHookResult> getGroupHook(GetGroupHookArgs args, InvokeOptions options)
public static Output<GetGroupHookResult> getGroupHook(GetGroupHookArgs args, InvokeOptions options)

    fn::invoke:
  function: gitlab:index/getGroupHook:getGroupHook
  arguments:
    # arguments dictionary
    data "gitlab_get_group_hook" "name" {
    # arguments
}

    The following arguments are supported:

    Group string
    The ID or full path of the group.
    HookId int
    The id of the group hook.
    Group string
    The ID or full path of the group.
    HookId int
    The id of the group hook.
    group string
    The ID or full path of the group.
    hook_id number
    The id of the group hook.
    group String
    The ID or full path of the group.
    hookId Integer
    The id of the group hook.
    group string
    The ID or full path of the group.
    hookId number
    The id of the group hook.
    group str
    The ID or full path of the group.
    hook_id int
    The id of the group hook.
    group String
    The ID or full path of the group.
    hookId Number
    The id of the group hook.

    getGroupHook Result

    The following output properties are available:

    AlertStatus string
    Lifecycle status of the webhook. Values include executable and disabled.
    BranchFilterStrategy string
    Filter push events by branch.
    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential notes events.
    CreatedAt string
    The date and time the hook was created in ISO8601 format.
    CustomWebhookTemplate string
    Set a custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events.
    DisabledUntil string
    Time until the webhook is re-enabled after being automatically disabled due to failures, in ISO8601 format. Null when the webhook is enabled.
    EmojiEvents bool
    Invoke the hook for emoji events.
    EnableSslVerification bool
    Enable ssl verification when invoking the hook.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events.
    Group string
    The ID or full path of the group.
    GroupId int
    The id of the group for the hook.
    HookId int
    The id of the group hook.
    Id string
    The ID of this data source. In the format <group:hook_id>.
    IssuesEvents bool
    Invoke the hook for issues events.
    JobEvents bool
    Invoke the hook for job events.
    MemberEvents bool
    Invoke the hook for member events.
    MergeRequestsEvents bool
    Invoke the hook for merge requests.
    MilestoneEvents bool
    Invoke the hook for milestone events.
    NoteEvents bool
    Invoke the hook for notes events.
    PipelineEvents bool
    Invoke the hook for pipeline events.
    ProjectEvents bool
    Invoke the hook for project events.
    PushEvents bool
    Invoke the hook for push events.
    PushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    ReleasesEvents bool
    Invoke the hook for releases events.
    ResourceAccessTokenEvents bool
    Invoke the hook for resource access token expiry events.
    SigningTokenPresent bool
    Whether a signingToken is configured server-side. Reflects the value returned by the GitLab API.
    SubgroupEvents bool
    Invoke the hook for subgroup events.
    TagPushEvents bool
    Invoke the hook for tag push events.
    Url string
    The url of the hook to invoke.
    VulnerabilityEvents bool
    Invoke the hook for vulnerability events.
    WikiPageEvents bool
    Invoke the hook for wiki page events.
    AlertStatus string
    Lifecycle status of the webhook. Values include executable and disabled.
    BranchFilterStrategy string
    Filter push events by branch.
    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential notes events.
    CreatedAt string
    The date and time the hook was created in ISO8601 format.
    CustomWebhookTemplate string
    Set a custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events.
    DisabledUntil string
    Time until the webhook is re-enabled after being automatically disabled due to failures, in ISO8601 format. Null when the webhook is enabled.
    EmojiEvents bool
    Invoke the hook for emoji events.
    EnableSslVerification bool
    Enable ssl verification when invoking the hook.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events.
    Group string
    The ID or full path of the group.
    GroupId int
    The id of the group for the hook.
    HookId int
    The id of the group hook.
    Id string
    The ID of this data source. In the format <group:hook_id>.
    IssuesEvents bool
    Invoke the hook for issues events.
    JobEvents bool
    Invoke the hook for job events.
    MemberEvents bool
    Invoke the hook for member events.
    MergeRequestsEvents bool
    Invoke the hook for merge requests.
    MilestoneEvents bool
    Invoke the hook for milestone events.
    NoteEvents bool
    Invoke the hook for notes events.
    PipelineEvents bool
    Invoke the hook for pipeline events.
    ProjectEvents bool
    Invoke the hook for project events.
    PushEvents bool
    Invoke the hook for push events.
    PushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    ReleasesEvents bool
    Invoke the hook for releases events.
    ResourceAccessTokenEvents bool
    Invoke the hook for resource access token expiry events.
    SigningTokenPresent bool
    Whether a signingToken is configured server-side. Reflects the value returned by the GitLab API.
    SubgroupEvents bool
    Invoke the hook for subgroup events.
    TagPushEvents bool
    Invoke the hook for tag push events.
    Url string
    The url of the hook to invoke.
    VulnerabilityEvents bool
    Invoke the hook for vulnerability events.
    WikiPageEvents bool
    Invoke the hook for wiki page events.
    alert_status string
    Lifecycle status of the webhook. Values include executable and disabled.
    branch_filter_strategy string
    Filter push events by branch.
    confidential_issues_events bool
    Invoke the hook for confidential issues events.
    confidential_note_events bool
    Invoke the hook for confidential notes events.
    created_at string
    The date and time the hook was created in ISO8601 format.
    custom_webhook_template string
    Set a custom webhook template.
    deployment_events bool
    Invoke the hook for deployment events.
    disabled_until string
    Time until the webhook is re-enabled after being automatically disabled due to failures, in ISO8601 format. Null when the webhook is enabled.
    emoji_events bool
    Invoke the hook for emoji events.
    enable_ssl_verification bool
    Enable ssl verification when invoking the hook.
    feature_flag_events bool
    Invoke the hook for feature flag events.
    group string
    The ID or full path of the group.
    group_id number
    The id of the group for the hook.
    hook_id number
    The id of the group hook.
    id string
    The ID of this data source. In the format <group:hook_id>.
    issues_events bool
    Invoke the hook for issues events.
    job_events bool
    Invoke the hook for job events.
    member_events bool
    Invoke the hook for member events.
    merge_requests_events bool
    Invoke the hook for merge requests.
    milestone_events bool
    Invoke the hook for milestone events.
    note_events bool
    Invoke the hook for notes events.
    pipeline_events bool
    Invoke the hook for pipeline events.
    project_events bool
    Invoke the hook for project events.
    push_events bool
    Invoke the hook for push events.
    push_events_branch_filter string
    Invoke the hook for push events on matching branches only.
    releases_events bool
    Invoke the hook for releases events.
    resource_access_token_events bool
    Invoke the hook for resource access token expiry events.
    signing_token_present bool
    Whether a signingToken is configured server-side. Reflects the value returned by the GitLab API.
    subgroup_events bool
    Invoke the hook for subgroup events.
    tag_push_events bool
    Invoke the hook for tag push events.
    url string
    The url of the hook to invoke.
    vulnerability_events bool
    Invoke the hook for vulnerability events.
    wiki_page_events bool
    Invoke the hook for wiki page events.
    alertStatus String
    Lifecycle status of the webhook. Values include executable and disabled.
    branchFilterStrategy String
    Filter push events by branch.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential notes events.
    createdAt String
    The date and time the hook was created in ISO8601 format.
    customWebhookTemplate String
    Set a custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events.
    disabledUntil String
    Time until the webhook is re-enabled after being automatically disabled due to failures, in ISO8601 format. Null when the webhook is enabled.
    emojiEvents Boolean
    Invoke the hook for emoji events.
    enableSslVerification Boolean
    Enable ssl verification when invoking the hook.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events.
    group String
    The ID or full path of the group.
    groupId Integer
    The id of the group for the hook.
    hookId Integer
    The id of the group hook.
    id String
    The ID of this data source. In the format <group:hook_id>.
    issuesEvents Boolean
    Invoke the hook for issues events.
    jobEvents Boolean
    Invoke the hook for job events.
    memberEvents Boolean
    Invoke the hook for member events.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests.
    milestoneEvents Boolean
    Invoke the hook for milestone events.
    noteEvents Boolean
    Invoke the hook for notes events.
    pipelineEvents Boolean
    Invoke the hook for pipeline events.
    projectEvents Boolean
    Invoke the hook for project events.
    pushEvents Boolean
    Invoke the hook for push events.
    pushEventsBranchFilter String
    Invoke the hook for push events on matching branches only.
    releasesEvents Boolean
    Invoke the hook for releases events.
    resourceAccessTokenEvents Boolean
    Invoke the hook for resource access token expiry events.
    signingTokenPresent Boolean
    Whether a signingToken is configured server-side. Reflects the value returned by the GitLab API.
    subgroupEvents Boolean
    Invoke the hook for subgroup events.
    tagPushEvents Boolean
    Invoke the hook for tag push events.
    url String
    The url of the hook to invoke.
    vulnerabilityEvents Boolean
    Invoke the hook for vulnerability events.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events.
    alertStatus string
    Lifecycle status of the webhook. Values include executable and disabled.
    branchFilterStrategy string
    Filter push events by branch.
    confidentialIssuesEvents boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents boolean
    Invoke the hook for confidential notes events.
    createdAt string
    The date and time the hook was created in ISO8601 format.
    customWebhookTemplate string
    Set a custom webhook template.
    deploymentEvents boolean
    Invoke the hook for deployment events.
    disabledUntil string
    Time until the webhook is re-enabled after being automatically disabled due to failures, in ISO8601 format. Null when the webhook is enabled.
    emojiEvents boolean
    Invoke the hook for emoji events.
    enableSslVerification boolean
    Enable ssl verification when invoking the hook.
    featureFlagEvents boolean
    Invoke the hook for feature flag events.
    group string
    The ID or full path of the group.
    groupId number
    The id of the group for the hook.
    hookId number
    The id of the group hook.
    id string
    The ID of this data source. In the format <group:hook_id>.
    issuesEvents boolean
    Invoke the hook for issues events.
    jobEvents boolean
    Invoke the hook for job events.
    memberEvents boolean
    Invoke the hook for member events.
    mergeRequestsEvents boolean
    Invoke the hook for merge requests.
    milestoneEvents boolean
    Invoke the hook for milestone events.
    noteEvents boolean
    Invoke the hook for notes events.
    pipelineEvents boolean
    Invoke the hook for pipeline events.
    projectEvents boolean
    Invoke the hook for project events.
    pushEvents boolean
    Invoke the hook for push events.
    pushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    releasesEvents boolean
    Invoke the hook for releases events.
    resourceAccessTokenEvents boolean
    Invoke the hook for resource access token expiry events.
    signingTokenPresent boolean
    Whether a signingToken is configured server-side. Reflects the value returned by the GitLab API.
    subgroupEvents boolean
    Invoke the hook for subgroup events.
    tagPushEvents boolean
    Invoke the hook for tag push events.
    url string
    The url of the hook to invoke.
    vulnerabilityEvents boolean
    Invoke the hook for vulnerability events.
    wikiPageEvents boolean
    Invoke the hook for wiki page events.
    alert_status str
    Lifecycle status of the webhook. Values include executable and disabled.
    branch_filter_strategy str
    Filter push events by branch.
    confidential_issues_events bool
    Invoke the hook for confidential issues events.
    confidential_note_events bool
    Invoke the hook for confidential notes events.
    created_at str
    The date and time the hook was created in ISO8601 format.
    custom_webhook_template str
    Set a custom webhook template.
    deployment_events bool
    Invoke the hook for deployment events.
    disabled_until str
    Time until the webhook is re-enabled after being automatically disabled due to failures, in ISO8601 format. Null when the webhook is enabled.
    emoji_events bool
    Invoke the hook for emoji events.
    enable_ssl_verification bool
    Enable ssl verification when invoking the hook.
    feature_flag_events bool
    Invoke the hook for feature flag events.
    group str
    The ID or full path of the group.
    group_id int
    The id of the group for the hook.
    hook_id int
    The id of the group hook.
    id str
    The ID of this data source. In the format <group:hook_id>.
    issues_events bool
    Invoke the hook for issues events.
    job_events bool
    Invoke the hook for job events.
    member_events bool
    Invoke the hook for member events.
    merge_requests_events bool
    Invoke the hook for merge requests.
    milestone_events bool
    Invoke the hook for milestone events.
    note_events bool
    Invoke the hook for notes events.
    pipeline_events bool
    Invoke the hook for pipeline events.
    project_events bool
    Invoke the hook for project events.
    push_events bool
    Invoke the hook for push events.
    push_events_branch_filter str
    Invoke the hook for push events on matching branches only.
    releases_events bool
    Invoke the hook for releases events.
    resource_access_token_events bool
    Invoke the hook for resource access token expiry events.
    signing_token_present bool
    Whether a signingToken is configured server-side. Reflects the value returned by the GitLab API.
    subgroup_events bool
    Invoke the hook for subgroup events.
    tag_push_events bool
    Invoke the hook for tag push events.
    url str
    The url of the hook to invoke.
    vulnerability_events bool
    Invoke the hook for vulnerability events.
    wiki_page_events bool
    Invoke the hook for wiki page events.
    alertStatus String
    Lifecycle status of the webhook. Values include executable and disabled.
    branchFilterStrategy String
    Filter push events by branch.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential notes events.
    createdAt String
    The date and time the hook was created in ISO8601 format.
    customWebhookTemplate String
    Set a custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events.
    disabledUntil String
    Time until the webhook is re-enabled after being automatically disabled due to failures, in ISO8601 format. Null when the webhook is enabled.
    emojiEvents Boolean
    Invoke the hook for emoji events.
    enableSslVerification Boolean
    Enable ssl verification when invoking the hook.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events.
    group String
    The ID or full path of the group.
    groupId Number
    The id of the group for the hook.
    hookId Number
    The id of the group hook.
    id String
    The ID of this data source. In the format <group:hook_id>.
    issuesEvents Boolean
    Invoke the hook for issues events.
    jobEvents Boolean
    Invoke the hook for job events.
    memberEvents Boolean
    Invoke the hook for member events.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests.
    milestoneEvents Boolean
    Invoke the hook for milestone events.
    noteEvents Boolean
    Invoke the hook for notes events.
    pipelineEvents Boolean
    Invoke the hook for pipeline events.
    projectEvents Boolean
    Invoke the hook for project events.
    pushEvents Boolean
    Invoke the hook for push events.
    pushEventsBranchFilter String
    Invoke the hook for push events on matching branches only.
    releasesEvents Boolean
    Invoke the hook for releases events.
    resourceAccessTokenEvents Boolean
    Invoke the hook for resource access token expiry events.
    signingTokenPresent Boolean
    Whether a signingToken is configured server-side. Reflects the value returned by the GitLab API.
    subgroupEvents Boolean
    Invoke the hook for subgroup events.
    tagPushEvents Boolean
    Invoke the hook for tag push events.
    url String
    The url of the hook to invoke.
    vulnerabilityEvents Boolean
    Invoke the hook for vulnerability events.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    Viewing docs for GitLab v10.1.1
    published on Thursday, Jul 23, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gitlab

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial