GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
gitlab.getGroupHook
Explore with Pulumi AI
The gitlab.GroupHook data source allows to retrieve details about a hook in a group.
Upstream API: GitLab REST API docs
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetGroupArgs;
import com.pulumi.gitlab.inputs.GetGroupHookArgs;
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 example = GitlabFunctions.getGroup(GetGroupArgs.builder()
            .id("foo/bar/baz")
            .build());
        final var exampleGetGroupHook = GitlabFunctions.getGroupHook(GetGroupHookArgs.builder()
            .group(example.applyValue(getGroupResult -> getGroupResult.id()))
            .hookId(1)
            .build());
    }
}
variables:
  example:
    fn::invoke:
      function: gitlab:getGroup
      arguments:
        id: foo/bar/baz
  exampleGetGroupHook:
    fn::invoke:
      function: gitlab:getGroupHook
      arguments:
        group: ${example.id}
        hookId: 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: Optional[pulumi.Input[str]] = None,
                   hook_id: Optional[pulumi.Input[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 dictionaryThe following arguments are supported:
getGroupHook Result
The following output properties are available:
- Confidential
Issues boolEvents  - Invoke the hook for confidential issues events.
 - Confidential
Note boolEvents  - Invoke the hook for confidential notes events.
 - Custom
Webhook stringTemplate  - Set a custom webhook template.
 - Deployment
Events bool - Invoke the hook for deployment events.
 - Enable
Ssl boolVerification  - Enable ssl verification when invoking the hook.
 - Group string
 - 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 string
 - The provider-assigned unique ID for this managed resource.
 - Issues
Events bool - Invoke the hook for issues events.
 - Job
Events bool - Invoke the hook for job events.
 - Merge
Requests boolEvents  - Invoke the hook for merge requests.
 - Note
Events bool - Invoke the hook for notes events.
 - Pipeline
Events bool - Invoke the hook for pipeline events.
 - Push
Events bool - Invoke the hook for push events.
 - Push
Events stringBranch Filter  - Invoke the hook for push events on matching branches only.
 - Releases
Events bool - Invoke the hook for releases events.
 - Subgroup
Events bool - Invoke the hook for subgroup events.
 - Tag
Push boolEvents  - Invoke the hook for tag push events.
 - Token string
 - A token to present when invoking the hook. The token is not available for imported resources.
 - Url string
 - The url of the hook to invoke.
 - Wiki
Page boolEvents  - Invoke the hook for wiki page events.
 
- Confidential
Issues boolEvents  - Invoke the hook for confidential issues events.
 - Confidential
Note boolEvents  - Invoke the hook for confidential notes events.
 - Custom
Webhook stringTemplate  - Set a custom webhook template.
 - Deployment
Events bool - Invoke the hook for deployment events.
 - Enable
Ssl boolVerification  - Enable ssl verification when invoking the hook.
 - Group string
 - 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 string
 - The provider-assigned unique ID for this managed resource.
 - Issues
Events bool - Invoke the hook for issues events.
 - Job
Events bool - Invoke the hook for job events.
 - Merge
Requests boolEvents  - Invoke the hook for merge requests.
 - Note
Events bool - Invoke the hook for notes events.
 - Pipeline
Events bool - Invoke the hook for pipeline events.
 - Push
Events bool - Invoke the hook for push events.
 - Push
Events stringBranch Filter  - Invoke the hook for push events on matching branches only.
 - Releases
Events bool - Invoke the hook for releases events.
 - Subgroup
Events bool - Invoke the hook for subgroup events.
 - Tag
Push boolEvents  - Invoke the hook for tag push events.
 - Token string
 - A token to present when invoking the hook. The token is not available for imported resources.
 - Url string
 - The url of the hook to invoke.
 - Wiki
Page boolEvents  - Invoke the hook for wiki page events.
 
- confidential
Issues BooleanEvents  - Invoke the hook for confidential issues events.
 - confidential
Note BooleanEvents  - Invoke the hook for confidential notes events.
 - custom
Webhook StringTemplate  - Set a custom webhook template.
 - deployment
Events Boolean - Invoke the hook for deployment events.
 - enable
Ssl BooleanVerification  - Enable ssl verification when invoking the hook.
 - group String
 - The ID or full path of the group.
 - group
Id Integer - The id of the group for the hook.
 - hook
Id Integer - The id of the group hook.
 - id String
 - The provider-assigned unique ID for this managed resource.
 - issues
Events Boolean - Invoke the hook for issues events.
 - job
Events Boolean - Invoke the hook for job events.
 - merge
Requests BooleanEvents  - Invoke the hook for merge requests.
 - note
Events Boolean - Invoke the hook for notes events.
 - pipeline
Events Boolean - Invoke the hook for pipeline events.
 - push
Events Boolean - Invoke the hook for push events.
 - push
Events StringBranch Filter  - Invoke the hook for push events on matching branches only.
 - releases
Events Boolean - Invoke the hook for releases events.
 - subgroup
Events Boolean - Invoke the hook for subgroup events.
 - tag
Push BooleanEvents  - Invoke the hook for tag push events.
 - token String
 - A token to present when invoking the hook. The token is not available for imported resources.
 - url String
 - The url of the hook to invoke.
 - wiki
Page BooleanEvents  - Invoke the hook for wiki page events.
 
- confidential
Issues booleanEvents  - Invoke the hook for confidential issues events.
 - confidential
Note booleanEvents  - Invoke the hook for confidential notes events.
 - custom
Webhook stringTemplate  - Set a custom webhook template.
 - deployment
Events boolean - Invoke the hook for deployment events.
 - enable
Ssl booleanVerification  - Enable ssl verification when invoking the hook.
 - 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 provider-assigned unique ID for this managed resource.
 - issues
Events boolean - Invoke the hook for issues events.
 - job
Events boolean - Invoke the hook for job events.
 - merge
Requests booleanEvents  - Invoke the hook for merge requests.
 - note
Events boolean - Invoke the hook for notes events.
 - pipeline
Events boolean - Invoke the hook for pipeline events.
 - push
Events boolean - Invoke the hook for push events.
 - push
Events stringBranch Filter  - Invoke the hook for push events on matching branches only.
 - releases
Events boolean - Invoke the hook for releases events.
 - subgroup
Events boolean - Invoke the hook for subgroup events.
 - tag
Push booleanEvents  - Invoke the hook for tag push events.
 - token string
 - A token to present when invoking the hook. The token is not available for imported resources.
 - url string
 - The url of the hook to invoke.
 - wiki
Page booleanEvents  - Invoke the hook for wiki page events.
 
- confidential_
issues_ boolevents  - Invoke the hook for confidential issues events.
 - confidential_
note_ boolevents  - Invoke the hook for confidential notes events.
 - custom_
webhook_ strtemplate  - Set a custom webhook template.
 - deployment_
events bool - Invoke the hook for deployment events.
 - enable_
ssl_ boolverification  - Enable ssl verification when invoking the hook.
 - 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 provider-assigned unique ID for this managed resource.
 - issues_
events bool - Invoke the hook for issues events.
 - job_
events bool - Invoke the hook for job events.
 - merge_
requests_ boolevents  - Invoke the hook for merge requests.
 - note_
events bool - Invoke the hook for notes events.
 - pipeline_
events bool - Invoke the hook for pipeline events.
 - push_
events bool - Invoke the hook for push events.
 - push_
events_ strbranch_ filter  - Invoke the hook for push events on matching branches only.
 - releases_
events bool - Invoke the hook for releases events.
 - subgroup_
events bool - Invoke the hook for subgroup events.
 - tag_
push_ boolevents  - Invoke the hook for tag push events.
 - token str
 - A token to present when invoking the hook. The token is not available for imported resources.
 - url str
 - The url of the hook to invoke.
 - wiki_
page_ boolevents  - Invoke the hook for wiki page events.
 
- confidential
Issues BooleanEvents  - Invoke the hook for confidential issues events.
 - confidential
Note BooleanEvents  - Invoke the hook for confidential notes events.
 - custom
Webhook StringTemplate  - Set a custom webhook template.
 - deployment
Events Boolean - Invoke the hook for deployment events.
 - enable
Ssl BooleanVerification  - Enable ssl verification when invoking the hook.
 - 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 provider-assigned unique ID for this managed resource.
 - issues
Events Boolean - Invoke the hook for issues events.
 - job
Events Boolean - Invoke the hook for job events.
 - merge
Requests BooleanEvents  - Invoke the hook for merge requests.
 - note
Events Boolean - Invoke the hook for notes events.
 - pipeline
Events Boolean - Invoke the hook for pipeline events.
 - push
Events Boolean - Invoke the hook for push events.
 - push
Events StringBranch Filter  - Invoke the hook for push events on matching branches only.
 - releases
Events Boolean - Invoke the hook for releases events.
 - subgroup
Events Boolean - Invoke the hook for subgroup events.
 - tag
Push BooleanEvents  - Invoke the hook for tag push events.
 - token String
 - A token to present when invoking the hook. The token is not available for imported resources.
 - url String
 - The url of the hook to invoke.
 - wiki
Page BooleanEvents  - 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 
gitlabTerraform Provider.