1. Packages
  2. Gitlab Provider
  3. API Docs
  4. GroupHook
GitLab v9.8.2 published on Tuesday, Jan 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

gitlab.GroupHook

gitlab logo
GitLab v9.8.2 published on Tuesday, Jan 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

    The gitlab.GroupHook resource allows to manage the lifecycle of a group hook.

    Note that push_events defaults to true.

    Upstream API: GitLab REST API docs

    Create GroupHook Resource

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

    Constructor syntax

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

@overload
def GroupHook(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              group: Optional[str] = None,
              url: Optional[str] = None,
              job_events: Optional[bool] = None,
              enable_ssl_verification: Optional[bool] = None,
              custom_webhook_template: Optional[str] = None,
              deployment_events: Optional[bool] = None,
              description: Optional[str] = None,
              emoji_events: Optional[bool] = None,
              merge_requests_events: Optional[bool] = None,
              feature_flag_events: Optional[bool] = None,
              confidential_note_events: Optional[bool] = None,
              issues_events: Optional[bool] = None,
              custom_headers: Optional[Sequence[GroupHookCustomHeaderArgs]] = None,
              branch_filter_strategy: Optional[str] = None,
              push_events_branch_filter: Optional[str] = None,
              note_events: Optional[bool] = None,
              pipeline_events: Optional[bool] = None,
              push_events: Optional[bool] = None,
              name: Optional[str] = None,
              releases_events: Optional[bool] = None,
              subgroup_events: Optional[bool] = None,
              tag_push_events: Optional[bool] = None,
              token: Optional[str] = None,
              confidential_issues_events: Optional[bool] = None,
              vulnerability_events: Optional[bool] = None,
              wiki_page_events: Optional[bool] = None)
    func NewGroupHook(ctx *Context, name string, args GroupHookArgs, opts ...ResourceOption) (*GroupHook, error)
    public GroupHook(string name, GroupHookArgs args, CustomResourceOptions? opts = null)
    public GroupHook(String name, GroupHookArgs args)
public GroupHook(String name, GroupHookArgs args, CustomResourceOptions options)

    type: gitlab:GroupHook
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 GroupHookArgs
    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 GroupHookArgs
    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 GroupHookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupHookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupHookArgs
    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 groupHookResource = new GitLab.GroupHook("groupHookResource", new()
{
    Group = "string",
    Url = "string",
    JobEvents = false,
    EnableSslVerification = false,
    CustomWebhookTemplate = "string",
    DeploymentEvents = false,
    Description = "string",
    EmojiEvents = false,
    MergeRequestsEvents = false,
    FeatureFlagEvents = false,
    ConfidentialNoteEvents = false,
    IssuesEvents = false,
    CustomHeaders = new[]
    {
        new GitLab.Inputs.GroupHookCustomHeaderArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    BranchFilterStrategy = "string",
    PushEventsBranchFilter = "string",
    NoteEvents = false,
    PipelineEvents = false,
    PushEvents = false,
    Name = "string",
    ReleasesEvents = false,
    SubgroupEvents = false,
    TagPushEvents = false,
    Token = "string",
    ConfidentialIssuesEvents = false,
    VulnerabilityEvents = false,
    WikiPageEvents = false,
});

    example, err := gitlab.NewGroupHook(ctx, "groupHookResource", &gitlab.GroupHookArgs{
	Group:                  pulumi.String("string"),
	Url:                    pulumi.String("string"),
	JobEvents:              pulumi.Bool(false),
	EnableSslVerification:  pulumi.Bool(false),
	CustomWebhookTemplate:  pulumi.String("string"),
	DeploymentEvents:       pulumi.Bool(false),
	Description:            pulumi.String("string"),
	EmojiEvents:            pulumi.Bool(false),
	MergeRequestsEvents:    pulumi.Bool(false),
	FeatureFlagEvents:      pulumi.Bool(false),
	ConfidentialNoteEvents: pulumi.Bool(false),
	IssuesEvents:           pulumi.Bool(false),
	CustomHeaders: gitlab.GroupHookCustomHeaderArray{
		&gitlab.GroupHookCustomHeaderArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	BranchFilterStrategy:     pulumi.String("string"),
	PushEventsBranchFilter:   pulumi.String("string"),
	NoteEvents:               pulumi.Bool(false),
	PipelineEvents:           pulumi.Bool(false),
	PushEvents:               pulumi.Bool(false),
	Name:                     pulumi.String("string"),
	ReleasesEvents:           pulumi.Bool(false),
	SubgroupEvents:           pulumi.Bool(false),
	TagPushEvents:            pulumi.Bool(false),
	Token:                    pulumi.String("string"),
	ConfidentialIssuesEvents: pulumi.Bool(false),
	VulnerabilityEvents:      pulumi.Bool(false),
	WikiPageEvents:           pulumi.Bool(false),
})

    var groupHookResource = new GroupHook("groupHookResource", GroupHookArgs.builder()
    .group("string")
    .url("string")
    .jobEvents(false)
    .enableSslVerification(false)
    .customWebhookTemplate("string")
    .deploymentEvents(false)
    .description("string")
    .emojiEvents(false)
    .mergeRequestsEvents(false)
    .featureFlagEvents(false)
    .confidentialNoteEvents(false)
    .issuesEvents(false)
    .customHeaders(GroupHookCustomHeaderArgs.builder()
        .key("string")
        .value("string")
        .build())
    .branchFilterStrategy("string")
    .pushEventsBranchFilter("string")
    .noteEvents(false)
    .pipelineEvents(false)
    .pushEvents(false)
    .name("string")
    .releasesEvents(false)
    .subgroupEvents(false)
    .tagPushEvents(false)
    .token("string")
    .confidentialIssuesEvents(false)
    .vulnerabilityEvents(false)
    .wikiPageEvents(false)
    .build());

    group_hook_resource = gitlab.GroupHook("groupHookResource",
    group="string",
    url="string",
    job_events=False,
    enable_ssl_verification=False,
    custom_webhook_template="string",
    deployment_events=False,
    description="string",
    emoji_events=False,
    merge_requests_events=False,
    feature_flag_events=False,
    confidential_note_events=False,
    issues_events=False,
    custom_headers=[{
        "key": "string",
        "value": "string",
    }],
    branch_filter_strategy="string",
    push_events_branch_filter="string",
    note_events=False,
    pipeline_events=False,
    push_events=False,
    name="string",
    releases_events=False,
    subgroup_events=False,
    tag_push_events=False,
    token="string",
    confidential_issues_events=False,
    vulnerability_events=False,
    wiki_page_events=False)

    const groupHookResource = new gitlab.GroupHook("groupHookResource", {
    group: "string",
    url: "string",
    jobEvents: false,
    enableSslVerification: false,
    customWebhookTemplate: "string",
    deploymentEvents: false,
    description: "string",
    emojiEvents: false,
    mergeRequestsEvents: false,
    featureFlagEvents: false,
    confidentialNoteEvents: false,
    issuesEvents: false,
    customHeaders: [{
        key: "string",
        value: "string",
    }],
    branchFilterStrategy: "string",
    pushEventsBranchFilter: "string",
    noteEvents: false,
    pipelineEvents: false,
    pushEvents: false,
    name: "string",
    releasesEvents: false,
    subgroupEvents: false,
    tagPushEvents: false,
    token: "string",
    confidentialIssuesEvents: false,
    vulnerabilityEvents: false,
    wikiPageEvents: false,
});

    type: gitlab:GroupHook
properties:
    branchFilterStrategy: string
    confidentialIssuesEvents: false
    confidentialNoteEvents: false
    customHeaders:
        - key: string
          value: string
    customWebhookTemplate: string
    deploymentEvents: false
    description: string
    emojiEvents: false
    enableSslVerification: false
    featureFlagEvents: false
    group: string
    issuesEvents: false
    jobEvents: false
    mergeRequestsEvents: false
    name: string
    noteEvents: false
    pipelineEvents: false
    pushEvents: false
    pushEventsBranchFilter: string
    releasesEvents: false
    subgroupEvents: false
    tagPushEvents: false
    token: string
    url: string
    vulnerabilityEvents: false
    wikiPageEvents: false

    GroupHook 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 GroupHook resource accepts the following input properties:

    Group string
    The full path or id of the group to add the hook to.
    Url string
    The url of the hook to invoke. Forces re-creation to preserve token.
    BranchFilterStrategy string
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events. Defaults to false.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential note events. Defaults to false.
    CustomHeaders List<Pulumi.GitLab.Inputs.GroupHookCustomHeader>
    Custom headers for the project webhook.
    CustomWebhookTemplate string
    Custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events. Defaults to false.
    Description string
    Description of the group webhook.
    EmojiEvents bool
    Invoke the hook for emoji events. Defaults to false.
    EnableSslVerification bool
    Enable SSL verification when invoking the hook. Defaults to true.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events. Defaults to false.
    IssuesEvents bool
    Invoke the hook for issues events. Defaults to false.
    JobEvents bool
    Invoke the hook for job events. Defaults to false.
    MergeRequestsEvents bool
    Invoke the hook for merge requests events. Defaults to false.
    Name string
    Name of the group webhook.
    NoteEvents bool
    Invoke the hook for note events. Defaults to false.
    PipelineEvents bool
    Invoke the hook for pipeline events. Defaults to false.
    PushEvents bool
    Invoke the hook for push events. Defaults to true.
    PushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    ReleasesEvents bool
    Invoke the hook for release events. Defaults to false.
    SubgroupEvents bool
    Invoke the hook for subgroup events. Defaults to false.
    TagPushEvents bool
    Invoke the hook for tag push events. Defaults to false.
    Token string
    A token to present when invoking the hook. The token is not available for imported resources.
    VulnerabilityEvents bool
    Invoke the hook for vulnerability events. Defaults to false.
    WikiPageEvents bool
    Invoke the hook for wiki page events. Defaults to false.
    Group string
    The full path or id of the group to add the hook to.
    Url string
    The url of the hook to invoke. Forces re-creation to preserve token.
    BranchFilterStrategy string
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events. Defaults to false.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential note events. Defaults to false.
    CustomHeaders []GroupHookCustomHeaderArgs
    Custom headers for the project webhook.
    CustomWebhookTemplate string
    Custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events. Defaults to false.
    Description string
    Description of the group webhook.
    EmojiEvents bool
    Invoke the hook for emoji events. Defaults to false.
    EnableSslVerification bool
    Enable SSL verification when invoking the hook. Defaults to true.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events. Defaults to false.
    IssuesEvents bool
    Invoke the hook for issues events. Defaults to false.
    JobEvents bool
    Invoke the hook for job events. Defaults to false.
    MergeRequestsEvents bool
    Invoke the hook for merge requests events. Defaults to false.
    Name string
    Name of the group webhook.
    NoteEvents bool
    Invoke the hook for note events. Defaults to false.
    PipelineEvents bool
    Invoke the hook for pipeline events. Defaults to false.
    PushEvents bool
    Invoke the hook for push events. Defaults to true.
    PushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    ReleasesEvents bool
    Invoke the hook for release events. Defaults to false.
    SubgroupEvents bool
    Invoke the hook for subgroup events. Defaults to false.
    TagPushEvents bool
    Invoke the hook for tag push events. Defaults to false.
    Token string
    A token to present when invoking the hook. The token is not available for imported resources.
    VulnerabilityEvents bool
    Invoke the hook for vulnerability events. Defaults to false.
    WikiPageEvents bool
    Invoke the hook for wiki page events. Defaults to false.
    group String
    The full path or id of the group to add the hook to.
    url String
    The url of the hook to invoke. Forces re-creation to preserve token.
    branchFilterStrategy String
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events. Defaults to false.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential note events. Defaults to false.
    customHeaders List<GroupHookCustomHeader>
    Custom headers for the project webhook.
    customWebhookTemplate String
    Custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events. Defaults to false.
    description String
    Description of the group webhook.
    emojiEvents Boolean
    Invoke the hook for emoji events. Defaults to false.
    enableSslVerification Boolean
    Enable SSL verification when invoking the hook. Defaults to true.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events. Defaults to false.
    issuesEvents Boolean
    Invoke the hook for issues events. Defaults to false.
    jobEvents Boolean
    Invoke the hook for job events. Defaults to false.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests events. Defaults to false.
    name String
    Name of the group webhook.
    noteEvents Boolean
    Invoke the hook for note events. Defaults to false.
    pipelineEvents Boolean
    Invoke the hook for pipeline events. Defaults to false.
    pushEvents Boolean
    Invoke the hook for push events. Defaults to true.
    pushEventsBranchFilter String
    Invoke the hook for push events on matching branches only.
    releasesEvents Boolean
    Invoke the hook for release events. Defaults to false.
    subgroupEvents Boolean
    Invoke the hook for subgroup events. Defaults to false.
    tagPushEvents Boolean
    Invoke the hook for tag push events. Defaults to false.
    token String
    A token to present when invoking the hook. The token is not available for imported resources.
    vulnerabilityEvents Boolean
    Invoke the hook for vulnerability events. Defaults to false.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events. Defaults to false.
    group string
    The full path or id of the group to add the hook to.
    url string
    The url of the hook to invoke. Forces re-creation to preserve token.
    branchFilterStrategy string
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents boolean
    Invoke the hook for confidential issues events. Defaults to false.
    confidentialNoteEvents boolean
    Invoke the hook for confidential note events. Defaults to false.
    customHeaders GroupHookCustomHeader[]
    Custom headers for the project webhook.
    customWebhookTemplate string
    Custom webhook template.
    deploymentEvents boolean
    Invoke the hook for deployment events. Defaults to false.
    description string
    Description of the group webhook.
    emojiEvents boolean
    Invoke the hook for emoji events. Defaults to false.
    enableSslVerification boolean
    Enable SSL verification when invoking the hook. Defaults to true.
    featureFlagEvents boolean
    Invoke the hook for feature flag events. Defaults to false.
    issuesEvents boolean
    Invoke the hook for issues events. Defaults to false.
    jobEvents boolean
    Invoke the hook for job events. Defaults to false.
    mergeRequestsEvents boolean
    Invoke the hook for merge requests events. Defaults to false.
    name string
    Name of the group webhook.
    noteEvents boolean
    Invoke the hook for note events. Defaults to false.
    pipelineEvents boolean
    Invoke the hook for pipeline events. Defaults to false.
    pushEvents boolean
    Invoke the hook for push events. Defaults to true.
    pushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    releasesEvents boolean
    Invoke the hook for release events. Defaults to false.
    subgroupEvents boolean
    Invoke the hook for subgroup events. Defaults to false.
    tagPushEvents boolean
    Invoke the hook for tag push events. Defaults to false.
    token string
    A token to present when invoking the hook. The token is not available for imported resources.
    vulnerabilityEvents boolean
    Invoke the hook for vulnerability events. Defaults to false.
    wikiPageEvents boolean
    Invoke the hook for wiki page events. Defaults to false.
    group str
    The full path or id of the group to add the hook to.
    url str
    The url of the hook to invoke. Forces re-creation to preserve token.
    branch_filter_strategy str
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidential_issues_events bool
    Invoke the hook for confidential issues events. Defaults to false.
    confidential_note_events bool
    Invoke the hook for confidential note events. Defaults to false.
    custom_headers Sequence[GroupHookCustomHeaderArgs]
    Custom headers for the project webhook.
    custom_webhook_template str
    Custom webhook template.
    deployment_events bool
    Invoke the hook for deployment events. Defaults to false.
    description str
    Description of the group webhook.
    emoji_events bool
    Invoke the hook for emoji events. Defaults to false.
    enable_ssl_verification bool
    Enable SSL verification when invoking the hook. Defaults to true.
    feature_flag_events bool
    Invoke the hook for feature flag events. Defaults to false.
    issues_events bool
    Invoke the hook for issues events. Defaults to false.
    job_events bool
    Invoke the hook for job events. Defaults to false.
    merge_requests_events bool
    Invoke the hook for merge requests events. Defaults to false.
    name str
    Name of the group webhook.
    note_events bool
    Invoke the hook for note events. Defaults to false.
    pipeline_events bool
    Invoke the hook for pipeline events. Defaults to false.
    push_events bool
    Invoke the hook for push events. Defaults to true.
    push_events_branch_filter str
    Invoke the hook for push events on matching branches only.
    releases_events bool
    Invoke the hook for release events. Defaults to false.
    subgroup_events bool
    Invoke the hook for subgroup events. Defaults to false.
    tag_push_events bool
    Invoke the hook for tag push events. Defaults to false.
    token str
    A token to present when invoking the hook. The token is not available for imported resources.
    vulnerability_events bool
    Invoke the hook for vulnerability events. Defaults to false.
    wiki_page_events bool
    Invoke the hook for wiki page events. Defaults to false.
    group String
    The full path or id of the group to add the hook to.
    url String
    The url of the hook to invoke. Forces re-creation to preserve token.
    branchFilterStrategy String
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events. Defaults to false.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential note events. Defaults to false.
    customHeaders List<Property Map>
    Custom headers for the project webhook.
    customWebhookTemplate String
    Custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events. Defaults to false.
    description String
    Description of the group webhook.
    emojiEvents Boolean
    Invoke the hook for emoji events. Defaults to false.
    enableSslVerification Boolean
    Enable SSL verification when invoking the hook. Defaults to true.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events. Defaults to false.
    issuesEvents Boolean
    Invoke the hook for issues events. Defaults to false.
    jobEvents Boolean
    Invoke the hook for job events. Defaults to false.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests events. Defaults to false.
    name String
    Name of the group webhook.
    noteEvents Boolean
    Invoke the hook for note events. Defaults to false.
    pipelineEvents Boolean
    Invoke the hook for pipeline events. Defaults to false.
    pushEvents Boolean
    Invoke the hook for push events. Defaults to true.
    pushEventsBranchFilter String
    Invoke the hook for push events on matching branches only.
    releasesEvents Boolean
    Invoke the hook for release events. Defaults to false.
    subgroupEvents Boolean
    Invoke the hook for subgroup events. Defaults to false.
    tagPushEvents Boolean
    Invoke the hook for tag push events. Defaults to false.
    token String
    A token to present when invoking the hook. The token is not available for imported resources.
    vulnerabilityEvents Boolean
    Invoke the hook for vulnerability events. Defaults to false.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events. Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GroupHook resource produces the following output properties:

    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.
    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.
    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.
    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.
    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.
    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.

    Look up Existing GroupHook Resource

    Get an existing GroupHook 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?: GroupHookState, opts?: CustomResourceOptions): GroupHook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branch_filter_strategy: Optional[str] = None,
        confidential_issues_events: Optional[bool] = None,
        confidential_note_events: Optional[bool] = None,
        custom_headers: Optional[Sequence[GroupHookCustomHeaderArgs]] = None,
        custom_webhook_template: Optional[str] = None,
        deployment_events: Optional[bool] = None,
        description: Optional[str] = None,
        emoji_events: Optional[bool] = None,
        enable_ssl_verification: Optional[bool] = None,
        feature_flag_events: Optional[bool] = None,
        group: Optional[str] = None,
        group_id: Optional[int] = None,
        hook_id: Optional[int] = None,
        issues_events: Optional[bool] = None,
        job_events: Optional[bool] = None,
        merge_requests_events: Optional[bool] = None,
        name: Optional[str] = None,
        note_events: Optional[bool] = None,
        pipeline_events: Optional[bool] = None,
        push_events: Optional[bool] = None,
        push_events_branch_filter: Optional[str] = None,
        releases_events: Optional[bool] = None,
        subgroup_events: Optional[bool] = None,
        tag_push_events: Optional[bool] = None,
        token: Optional[str] = None,
        url: Optional[str] = None,
        vulnerability_events: Optional[bool] = None,
        wiki_page_events: Optional[bool] = None) -> GroupHook
    func GetGroupHook(ctx *Context, name string, id IDInput, state *GroupHookState, opts ...ResourceOption) (*GroupHook, error)
    public static GroupHook Get(string name, Input<string> id, GroupHookState? state, CustomResourceOptions? opts = null)
    public static GroupHook get(String name, Output<String> id, GroupHookState state, CustomResourceOptions options)
    resources:  _:    type: gitlab:GroupHook    get:      id: ${id}
    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:
    BranchFilterStrategy string
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events. Defaults to false.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential note events. Defaults to false.
    CustomHeaders List<Pulumi.GitLab.Inputs.GroupHookCustomHeader>
    Custom headers for the project webhook.
    CustomWebhookTemplate string
    Custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events. Defaults to false.
    Description string
    Description of the group webhook.
    EmojiEvents bool
    Invoke the hook for emoji events. Defaults to false.
    EnableSslVerification bool
    Enable SSL verification when invoking the hook. Defaults to true.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events. Defaults to false.
    Group string
    The full path or id of the group to add the hook to.
    GroupId int
    The id of the group for the hook.
    HookId int
    The id of the group hook.
    IssuesEvents bool
    Invoke the hook for issues events. Defaults to false.
    JobEvents bool
    Invoke the hook for job events. Defaults to false.
    MergeRequestsEvents bool
    Invoke the hook for merge requests events. Defaults to false.
    Name string
    Name of the group webhook.
    NoteEvents bool
    Invoke the hook for note events. Defaults to false.
    PipelineEvents bool
    Invoke the hook for pipeline events. Defaults to false.
    PushEvents bool
    Invoke the hook for push events. Defaults to true.
    PushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    ReleasesEvents bool
    Invoke the hook for release events. Defaults to false.
    SubgroupEvents bool
    Invoke the hook for subgroup events. Defaults to false.
    TagPushEvents bool
    Invoke the hook for tag push events. Defaults to false.
    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. Forces re-creation to preserve token.
    VulnerabilityEvents bool
    Invoke the hook for vulnerability events. Defaults to false.
    WikiPageEvents bool
    Invoke the hook for wiki page events. Defaults to false.
    BranchFilterStrategy string
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events. Defaults to false.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential note events. Defaults to false.
    CustomHeaders []GroupHookCustomHeaderArgs
    Custom headers for the project webhook.
    CustomWebhookTemplate string
    Custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events. Defaults to false.
    Description string
    Description of the group webhook.
    EmojiEvents bool
    Invoke the hook for emoji events. Defaults to false.
    EnableSslVerification bool
    Enable SSL verification when invoking the hook. Defaults to true.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events. Defaults to false.
    Group string
    The full path or id of the group to add the hook to.
    GroupId int
    The id of the group for the hook.
    HookId int
    The id of the group hook.
    IssuesEvents bool
    Invoke the hook for issues events. Defaults to false.
    JobEvents bool
    Invoke the hook for job events. Defaults to false.
    MergeRequestsEvents bool
    Invoke the hook for merge requests events. Defaults to false.
    Name string
    Name of the group webhook.
    NoteEvents bool
    Invoke the hook for note events. Defaults to false.
    PipelineEvents bool
    Invoke the hook for pipeline events. Defaults to false.
    PushEvents bool
    Invoke the hook for push events. Defaults to true.
    PushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    ReleasesEvents bool
    Invoke the hook for release events. Defaults to false.
    SubgroupEvents bool
    Invoke the hook for subgroup events. Defaults to false.
    TagPushEvents bool
    Invoke the hook for tag push events. Defaults to false.
    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. Forces re-creation to preserve token.
    VulnerabilityEvents bool
    Invoke the hook for vulnerability events. Defaults to false.
    WikiPageEvents bool
    Invoke the hook for wiki page events. Defaults to false.
    branchFilterStrategy String
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events. Defaults to false.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential note events. Defaults to false.
    customHeaders List<GroupHookCustomHeader>
    Custom headers for the project webhook.
    customWebhookTemplate String
    Custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events. Defaults to false.
    description String
    Description of the group webhook.
    emojiEvents Boolean
    Invoke the hook for emoji events. Defaults to false.
    enableSslVerification Boolean
    Enable SSL verification when invoking the hook. Defaults to true.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events. Defaults to false.
    group String
    The full path or id of the group to add the hook to.
    groupId Integer
    The id of the group for the hook.
    hookId Integer
    The id of the group hook.
    issuesEvents Boolean
    Invoke the hook for issues events. Defaults to false.
    jobEvents Boolean
    Invoke the hook for job events. Defaults to false.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests events. Defaults to false.
    name String
    Name of the group webhook.
    noteEvents Boolean
    Invoke the hook for note events. Defaults to false.
    pipelineEvents Boolean
    Invoke the hook for pipeline events. Defaults to false.
    pushEvents Boolean
    Invoke the hook for push events. Defaults to true.
    pushEventsBranchFilter String
    Invoke the hook for push events on matching branches only.
    releasesEvents Boolean
    Invoke the hook for release events. Defaults to false.
    subgroupEvents Boolean
    Invoke the hook for subgroup events. Defaults to false.
    tagPushEvents Boolean
    Invoke the hook for tag push events. Defaults to false.
    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. Forces re-creation to preserve token.
    vulnerabilityEvents Boolean
    Invoke the hook for vulnerability events. Defaults to false.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events. Defaults to false.
    branchFilterStrategy string
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents boolean
    Invoke the hook for confidential issues events. Defaults to false.
    confidentialNoteEvents boolean
    Invoke the hook for confidential note events. Defaults to false.
    customHeaders GroupHookCustomHeader[]
    Custom headers for the project webhook.
    customWebhookTemplate string
    Custom webhook template.
    deploymentEvents boolean
    Invoke the hook for deployment events. Defaults to false.
    description string
    Description of the group webhook.
    emojiEvents boolean
    Invoke the hook for emoji events. Defaults to false.
    enableSslVerification boolean
    Enable SSL verification when invoking the hook. Defaults to true.
    featureFlagEvents boolean
    Invoke the hook for feature flag events. Defaults to false.
    group string
    The full path or id of the group to add the hook to.
    groupId number
    The id of the group for the hook.
    hookId number
    The id of the group hook.
    issuesEvents boolean
    Invoke the hook for issues events. Defaults to false.
    jobEvents boolean
    Invoke the hook for job events. Defaults to false.
    mergeRequestsEvents boolean
    Invoke the hook for merge requests events. Defaults to false.
    name string
    Name of the group webhook.
    noteEvents boolean
    Invoke the hook for note events. Defaults to false.
    pipelineEvents boolean
    Invoke the hook for pipeline events. Defaults to false.
    pushEvents boolean
    Invoke the hook for push events. Defaults to true.
    pushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    releasesEvents boolean
    Invoke the hook for release events. Defaults to false.
    subgroupEvents boolean
    Invoke the hook for subgroup events. Defaults to false.
    tagPushEvents boolean
    Invoke the hook for tag push events. Defaults to false.
    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. Forces re-creation to preserve token.
    vulnerabilityEvents boolean
    Invoke the hook for vulnerability events. Defaults to false.
    wikiPageEvents boolean
    Invoke the hook for wiki page events. Defaults to false.
    branch_filter_strategy str
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidential_issues_events bool
    Invoke the hook for confidential issues events. Defaults to false.
    confidential_note_events bool
    Invoke the hook for confidential note events. Defaults to false.
    custom_headers Sequence[GroupHookCustomHeaderArgs]
    Custom headers for the project webhook.
    custom_webhook_template str
    Custom webhook template.
    deployment_events bool
    Invoke the hook for deployment events. Defaults to false.
    description str
    Description of the group webhook.
    emoji_events bool
    Invoke the hook for emoji events. Defaults to false.
    enable_ssl_verification bool
    Enable SSL verification when invoking the hook. Defaults to true.
    feature_flag_events bool
    Invoke the hook for feature flag events. Defaults to false.
    group str
    The full path or id of the group to add the hook to.
    group_id int
    The id of the group for the hook.
    hook_id int
    The id of the group hook.
    issues_events bool
    Invoke the hook for issues events. Defaults to false.
    job_events bool
    Invoke the hook for job events. Defaults to false.
    merge_requests_events bool
    Invoke the hook for merge requests events. Defaults to false.
    name str
    Name of the group webhook.
    note_events bool
    Invoke the hook for note events. Defaults to false.
    pipeline_events bool
    Invoke the hook for pipeline events. Defaults to false.
    push_events bool
    Invoke the hook for push events. Defaults to true.
    push_events_branch_filter str
    Invoke the hook for push events on matching branches only.
    releases_events bool
    Invoke the hook for release events. Defaults to false.
    subgroup_events bool
    Invoke the hook for subgroup events. Defaults to false.
    tag_push_events bool
    Invoke the hook for tag push events. Defaults to false.
    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. Forces re-creation to preserve token.
    vulnerability_events bool
    Invoke the hook for vulnerability events. Defaults to false.
    wiki_page_events bool
    Invoke the hook for wiki page events. Defaults to false.
    branchFilterStrategy String
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events. Defaults to false.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential note events. Defaults to false.
    customHeaders List<Property Map>
    Custom headers for the project webhook.
    customWebhookTemplate String
    Custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events. Defaults to false.
    description String
    Description of the group webhook.
    emojiEvents Boolean
    Invoke the hook for emoji events. Defaults to false.
    enableSslVerification Boolean
    Enable SSL verification when invoking the hook. Defaults to true.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events. Defaults to false.
    group String
    The full path or id of the group to add the hook to.
    groupId Number
    The id of the group for the hook.
    hookId Number
    The id of the group hook.
    issuesEvents Boolean
    Invoke the hook for issues events. Defaults to false.
    jobEvents Boolean
    Invoke the hook for job events. Defaults to false.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests events. Defaults to false.
    name String
    Name of the group webhook.
    noteEvents Boolean
    Invoke the hook for note events. Defaults to false.
    pipelineEvents Boolean
    Invoke the hook for pipeline events. Defaults to false.
    pushEvents Boolean
    Invoke the hook for push events. Defaults to true.
    pushEventsBranchFilter String
    Invoke the hook for push events on matching branches only.
    releasesEvents Boolean
    Invoke the hook for release events. Defaults to false.
    subgroupEvents Boolean
    Invoke the hook for subgroup events. Defaults to false.
    tagPushEvents Boolean
    Invoke the hook for tag push events. Defaults to false.
    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. Forces re-creation to preserve token.
    vulnerabilityEvents Boolean
    Invoke the hook for vulnerability events. Defaults to false.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events. Defaults to false.

    Supporting Types

    GroupHookCustomHeader, GroupHookCustomHeaderArgs

    Key string
    Key of the custom header.
    Value string
    Value of the custom header. This value cannot be imported.
    Key string
    Key of the custom header.
    Value string
    Value of the custom header. This value cannot be imported.
    key String
    Key of the custom header.
    value String
    Value of the custom header. This value cannot be imported.
    key string
    Key of the custom header.
    value string
    Value of the custom header. This value cannot be imported.
    key str
    Key of the custom header.
    value str
    Value of the custom header. This value cannot be imported.
    key String
    Key of the custom header.
    value String
    Value of the custom header. This value cannot be imported.

    Import

    Starting in Terraform v1.5.0, you can use an import block to import gitlab_group_hook. For example:

    terraform

    import {

    to = gitlab_group_hook.example

    id = “see CLI command below for ID”

    }

    Importing using the CLI is supported with the following syntax:

    A GitLab Group Hook can be imported using a key composed of <group-id>:<hook-id>, e.g.

    $ pulumi import gitlab:index/groupHook:GroupHook example "12345:1"

    NOTE: the token resource attribute is not available for imported resources as this information cannot be read from the GitLab API.

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

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v9.8.2 published on Tuesday, Jan 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gitlab
      Meet Neo: Your AI Platform Teammate