Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. getGroupHook
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.getGroupHook

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
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

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());

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

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>
Copy
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]
Copy
func LookupGroupHook(ctx *Context, args *LookupGroupHookArgs, opts ...InvokeOption) (*LookupGroupHookResult, error)
func LookupGroupHookOutput(ctx *Context, args *LookupGroupHookOutputArgs, opts ...InvokeOption) LookupGroupHookResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGroupHookResult> getGroupHook(GetGroupHookArgs args, InvokeOptions options)
public static Output<GetGroupHookResult> getGroupHook(GetGroupHookArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gitlab:index/getGroupHook:getGroupHook
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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

getGroupHook Result

The following output properties are available:

ConfidentialIssuesEvents bool
Invoke the hook for confidential issues events.
ConfidentialNoteEvents bool
Invoke the hook for confidential notes events.
CustomWebhookTemplate string
Set a custom webhook template.
DeploymentEvents bool
Invoke the hook for deployment events.
EnableSslVerification bool
Enable ssl verification when invoking the hook.
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 provider-assigned unique ID for this managed resource.
IssuesEvents bool
Invoke the hook for issues events.
JobEvents bool
Invoke the hook for job events.
MergeRequestsEvents bool
Invoke the hook for merge requests.
NoteEvents bool
Invoke the hook for notes events.
PipelineEvents bool
Invoke the hook for pipeline 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.
SubgroupEvents bool
Invoke the hook for subgroup events.
TagPushEvents bool
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.
WikiPageEvents bool
Invoke the hook for wiki page events.
ConfidentialIssuesEvents bool
Invoke the hook for confidential issues events.
ConfidentialNoteEvents bool
Invoke the hook for confidential notes events.
CustomWebhookTemplate string
Set a custom webhook template.
DeploymentEvents bool
Invoke the hook for deployment events.
EnableSslVerification bool
Enable ssl verification when invoking the hook.
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 provider-assigned unique ID for this managed resource.
IssuesEvents bool
Invoke the hook for issues events.
JobEvents bool
Invoke the hook for job events.
MergeRequestsEvents bool
Invoke the hook for merge requests.
NoteEvents bool
Invoke the hook for notes events.
PipelineEvents bool
Invoke the hook for pipeline 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.
SubgroupEvents bool
Invoke the hook for subgroup events.
TagPushEvents bool
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.
WikiPageEvents bool
Invoke the hook for wiki page events.
confidentialIssuesEvents Boolean
Invoke the hook for confidential issues events.
confidentialNoteEvents Boolean
Invoke the hook for confidential notes events.
customWebhookTemplate String
Set a custom webhook template.
deploymentEvents Boolean
Invoke the hook for deployment events.
enableSslVerification Boolean
Enable ssl verification when invoking the hook.
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 provider-assigned unique ID for this managed resource.
issuesEvents Boolean
Invoke the hook for issues events.
jobEvents Boolean
Invoke the hook for job events.
mergeRequestsEvents Boolean
Invoke the hook for merge requests.
noteEvents Boolean
Invoke the hook for notes events.
pipelineEvents Boolean
Invoke the hook for pipeline 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.
subgroupEvents Boolean
Invoke the hook for subgroup events.
tagPushEvents Boolean
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.
wikiPageEvents Boolean
Invoke the hook for wiki page events.
confidentialIssuesEvents boolean
Invoke the hook for confidential issues events.
confidentialNoteEvents boolean
Invoke the hook for confidential notes events.
customWebhookTemplate string
Set a custom webhook template.
deploymentEvents boolean
Invoke the hook for deployment events.
enableSslVerification boolean
Enable ssl verification when invoking the hook.
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 provider-assigned unique ID for this managed resource.
issuesEvents boolean
Invoke the hook for issues events.
jobEvents boolean
Invoke the hook for job events.
mergeRequestsEvents boolean
Invoke the hook for merge requests.
noteEvents boolean
Invoke the hook for notes events.
pipelineEvents boolean
Invoke the hook for pipeline 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.
subgroupEvents boolean
Invoke the hook for subgroup events.
tagPushEvents boolean
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.
wikiPageEvents boolean
Invoke the hook for wiki page events.
confidential_issues_events bool
Invoke the hook for confidential issues events.
confidential_note_events bool
Invoke the hook for confidential notes events.
custom_webhook_template str
Set a custom webhook template.
deployment_events bool
Invoke the hook for deployment events.
enable_ssl_verification bool
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_events bool
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_branch_filter str
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_events bool
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_events bool
Invoke the hook for wiki page events.
confidentialIssuesEvents Boolean
Invoke the hook for confidential issues events.
confidentialNoteEvents Boolean
Invoke the hook for confidential notes events.
customWebhookTemplate String
Set a custom webhook template.
deploymentEvents Boolean
Invoke the hook for deployment events.
enableSslVerification Boolean
Enable ssl verification when invoking the hook.
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 provider-assigned unique ID for this managed resource.
issuesEvents Boolean
Invoke the hook for issues events.
jobEvents Boolean
Invoke the hook for job events.
mergeRequestsEvents Boolean
Invoke the hook for merge requests.
noteEvents Boolean
Invoke the hook for notes events.
pipelineEvents Boolean
Invoke the hook for pipeline 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.
subgroupEvents Boolean
Invoke the hook for subgroup events.
tagPushEvents Boolean
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.
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 v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab