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

gitlab.GroupHook

Explore with Pulumi AI

gitlab logo
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

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

    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,
              merge_requests_events: Optional[bool] = None,
              custom_webhook_template: Optional[str] = None,
              name: Optional[str] = None,
              deployment_events: Optional[bool] = None,
              description: Optional[str] = None,
              enable_ssl_verification: Optional[bool] = None,
              feature_flag_events: Optional[bool] = None,
              confidential_note_events: Optional[bool] = None,
              note_events: Optional[bool] = None,
              job_events: Optional[bool] = None,
              wiki_page_events: Optional[bool] = None,
              custom_headers: Optional[Sequence[GroupHookCustomHeaderArgs]] = None,
              issues_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,
              confidential_issues_events: Optional[bool] = None,
              branch_filter_strategy: Optional[str] = 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",
    MergeRequestsEvents = false,
    CustomWebhookTemplate = "string",
    Name = "string",
    DeploymentEvents = false,
    Description = "string",
    EnableSslVerification = false,
    FeatureFlagEvents = false,
    ConfidentialNoteEvents = false,
    NoteEvents = false,
    JobEvents = false,
    WikiPageEvents = false,
    CustomHeaders = new[]
    {
        new GitLab.Inputs.GroupHookCustomHeaderArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    IssuesEvents = false,
    PipelineEvents = false,
    PushEvents = false,
    PushEventsBranchFilter = "string",
    ReleasesEvents = false,
    SubgroupEvents = false,
    TagPushEvents = false,
    Token = "string",
    ConfidentialIssuesEvents = false,
    BranchFilterStrategy = "string",
});

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

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

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

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

    type: gitlab:GroupHook
properties:
    branchFilterStrategy: string
    confidentialIssuesEvents: false
    confidentialNoteEvents: false
    customHeaders:
        - key: string
          value: string
    customWebhookTemplate: string
    deploymentEvents: false
    description: string
    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
    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.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential note events.
    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.
    Description string
    Description of the group webhook.
    EnableSslVerification bool
    Enable SSL verification when invoking the hook.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events.
    IssuesEvents bool
    Invoke the hook for issues events.
    JobEvents bool
    Invoke the hook for job events.
    MergeRequestsEvents bool
    Invoke the hook for merge requests events.
    Name string
    Name of the group webhook.
    NoteEvents bool
    Invoke the hook for note 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 release 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.
    WikiPageEvents bool
    Invoke the hook for wiki page events.
    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.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential note events.
    CustomHeaders []GroupHookCustomHeaderArgs
    Custom headers for the project webhook.
    CustomWebhookTemplate string
    Custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events.
    Description string
    Description of the group webhook.
    EnableSslVerification bool
    Enable SSL verification when invoking the hook.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events.
    IssuesEvents bool
    Invoke the hook for issues events.
    JobEvents bool
    Invoke the hook for job events.
    MergeRequestsEvents bool
    Invoke the hook for merge requests events.
    Name string
    Name of the group webhook.
    NoteEvents bool
    Invoke the hook for note 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 release 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.
    WikiPageEvents bool
    Invoke the hook for wiki page events.
    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.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential note events.
    customHeaders List<GroupHookCustomHeader>
    Custom headers for the project webhook.
    customWebhookTemplate String
    Custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events.
    description String
    Description of the group webhook.
    enableSslVerification Boolean
    Enable SSL verification when invoking the hook.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events.
    issuesEvents Boolean
    Invoke the hook for issues events.
    jobEvents Boolean
    Invoke the hook for job events.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests events.
    name String
    Name of the group webhook.
    noteEvents Boolean
    Invoke the hook for note 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 release 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.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events.
    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.
    confidentialNoteEvents boolean
    Invoke the hook for confidential note events.
    customHeaders GroupHookCustomHeader[]
    Custom headers for the project webhook.
    customWebhookTemplate string
    Custom webhook template.
    deploymentEvents boolean
    Invoke the hook for deployment events.
    description string
    Description of the group webhook.
    enableSslVerification boolean
    Enable SSL verification when invoking the hook.
    featureFlagEvents boolean
    Invoke the hook for feature flag events.
    issuesEvents boolean
    Invoke the hook for issues events.
    jobEvents boolean
    Invoke the hook for job events.
    mergeRequestsEvents boolean
    Invoke the hook for merge requests events.
    name string
    Name of the group webhook.
    noteEvents boolean
    Invoke the hook for note 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 release 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.
    wikiPageEvents boolean
    Invoke the hook for wiki page events.
    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.
    confidential_note_events bool
    Invoke the hook for confidential note events.
    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.
    description str
    Description of the group webhook.
    enable_ssl_verification bool
    Enable SSL verification when invoking the hook.
    feature_flag_events bool
    Invoke the hook for feature flag events.
    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 events.
    name str
    Name of the group webhook.
    note_events bool
    Invoke the hook for note 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 release 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.
    wiki_page_events bool
    Invoke the hook for wiki page events.
    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.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential note events.
    customHeaders List<Property Map>
    Custom headers for the project webhook.
    customWebhookTemplate String
    Custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events.
    description String
    Description of the group webhook.
    enableSslVerification Boolean
    Enable SSL verification when invoking the hook.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events.
    issuesEvents Boolean
    Invoke the hook for issues events.
    jobEvents Boolean
    Invoke the hook for job events.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests events.
    name String
    Name of the group webhook.
    noteEvents Boolean
    Invoke the hook for note 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 release 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.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events.

    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,
        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,
        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.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential note events.
    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.
    Description string
    Description of the group webhook.
    EnableSslVerification bool
    Enable SSL verification when invoking the hook.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events.
    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.
    JobEvents bool
    Invoke the hook for job events.
    MergeRequestsEvents bool
    Invoke the hook for merge requests events.
    Name string
    Name of the group webhook.
    NoteEvents bool
    Invoke the hook for note 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 release 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. Forces re-creation to preserve token.
    WikiPageEvents bool
    Invoke the hook for wiki page events.
    BranchFilterStrategy string
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential note events.
    CustomHeaders []GroupHookCustomHeaderArgs
    Custom headers for the project webhook.
    CustomWebhookTemplate string
    Custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events.
    Description string
    Description of the group webhook.
    EnableSslVerification bool
    Enable SSL verification when invoking the hook.
    FeatureFlagEvents bool
    Invoke the hook for feature flag events.
    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.
    JobEvents bool
    Invoke the hook for job events.
    MergeRequestsEvents bool
    Invoke the hook for merge requests events.
    Name string
    Name of the group webhook.
    NoteEvents bool
    Invoke the hook for note 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 release 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. Forces re-creation to preserve token.
    WikiPageEvents bool
    Invoke the hook for wiki page events.
    branchFilterStrategy String
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential note events.
    customHeaders List<GroupHookCustomHeader>
    Custom headers for the project webhook.
    customWebhookTemplate String
    Custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events.
    description String
    Description of the group webhook.
    enableSslVerification Boolean
    Enable SSL verification when invoking the hook.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events.
    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.
    jobEvents Boolean
    Invoke the hook for job events.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests events.
    name String
    Name of the group webhook.
    noteEvents Boolean
    Invoke the hook for note 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 release 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. Forces re-creation to preserve token.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events.
    branchFilterStrategy string
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents boolean
    Invoke the hook for confidential note events.
    customHeaders GroupHookCustomHeader[]
    Custom headers for the project webhook.
    customWebhookTemplate string
    Custom webhook template.
    deploymentEvents boolean
    Invoke the hook for deployment events.
    description string
    Description of the group webhook.
    enableSslVerification boolean
    Enable SSL verification when invoking the hook.
    featureFlagEvents boolean
    Invoke the hook for feature flag events.
    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.
    jobEvents boolean
    Invoke the hook for job events.
    mergeRequestsEvents boolean
    Invoke the hook for merge requests events.
    name string
    Name of the group webhook.
    noteEvents boolean
    Invoke the hook for note 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 release 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. Forces re-creation to preserve token.
    wikiPageEvents boolean
    Invoke the hook for wiki page events.
    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.
    confidential_note_events bool
    Invoke the hook for confidential note events.
    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.
    description str
    Description of the group webhook.
    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 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.
    job_events bool
    Invoke the hook for job events.
    merge_requests_events bool
    Invoke the hook for merge requests events.
    name str
    Name of the group webhook.
    note_events bool
    Invoke the hook for note 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 release 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. Forces re-creation to preserve token.
    wiki_page_events bool
    Invoke the hook for wiki page events.
    branchFilterStrategy String
    Filter push events by branch. Valid values are: wildcard, regex, all_branches.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential note events.
    customHeaders List<Property Map>
    Custom headers for the project webhook.
    customWebhookTemplate String
    Custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events.
    description String
    Description of the group webhook.
    enableSslVerification Boolean
    Enable SSL verification when invoking the hook.
    featureFlagEvents Boolean
    Invoke the hook for feature flag events.
    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.
    jobEvents Boolean
    Invoke the hook for job events.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests events.
    name String
    Name of the group webhook.
    noteEvents Boolean
    Invoke the hook for note 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 release 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. Forces re-creation to preserve token.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events.

    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”

    }

    Import using the CLI is supported using 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 v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
    pulumi/pulumi-gitlab