Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. GitxWebhook
Harness v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness

harness.platform.GitxWebhook

Explore with Pulumi AI

Harness v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness

Resource for creating a Harness pipeline.

Create GitxWebhook Resource

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

Constructor syntax

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

@overload
def GitxWebhook(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                connector_ref: Optional[str] = None,
                identifier: Optional[str] = None,
                repo_name: Optional[str] = None,
                description: Optional[str] = None,
                folder_paths: Optional[Sequence[str]] = None,
                is_enabled: Optional[bool] = None,
                name: Optional[str] = None,
                org_id: Optional[str] = None,
                project_id: Optional[str] = None,
                tags: Optional[Sequence[str]] = None)
func NewGitxWebhook(ctx *Context, name string, args GitxWebhookArgs, opts ...ResourceOption) (*GitxWebhook, error)
public GitxWebhook(string name, GitxWebhookArgs args, CustomResourceOptions? opts = null)
public GitxWebhook(String name, GitxWebhookArgs args)
public GitxWebhook(String name, GitxWebhookArgs args, CustomResourceOptions options)

type: harness:platform:GitxWebhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GitxWebhookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GitxWebhookArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GitxWebhookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GitxWebhookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GitxWebhookArgs
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 gitxWebhookResource = new Harness.Platform.GitxWebhook("gitxWebhookResource", new()
{
    ConnectorRef = "string",
    Identifier = "string",
    RepoName = "string",
    Description = "string",
    FolderPaths = new[]
    {
        "string",
    },
    IsEnabled = false,
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := platform.NewGitxWebhook(ctx, "gitxWebhookResource", &platform.GitxWebhookArgs{
	ConnectorRef: pulumi.String("string"),
	Identifier:   pulumi.String("string"),
	RepoName:     pulumi.String("string"),
	Description:  pulumi.String("string"),
	FolderPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsEnabled: pulumi.Bool(false),
	Name:      pulumi.String("string"),
	OrgId:     pulumi.String("string"),
	ProjectId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var gitxWebhookResource = new GitxWebhook("gitxWebhookResource", GitxWebhookArgs.builder()
    .connectorRef("string")
    .identifier("string")
    .repoName("string")
    .description("string")
    .folderPaths("string")
    .isEnabled(false)
    .name("string")
    .orgId("string")
    .projectId("string")
    .tags("string")
    .build());
Copy
gitx_webhook_resource = harness.platform.GitxWebhook("gitxWebhookResource",
    connector_ref="string",
    identifier="string",
    repo_name="string",
    description="string",
    folder_paths=["string"],
    is_enabled=False,
    name="string",
    org_id="string",
    project_id="string",
    tags=["string"])
Copy
const gitxWebhookResource = new harness.platform.GitxWebhook("gitxWebhookResource", {
    connectorRef: "string",
    identifier: "string",
    repoName: "string",
    description: "string",
    folderPaths: ["string"],
    isEnabled: false,
    name: "string",
    orgId: "string",
    projectId: "string",
    tags: ["string"],
});
Copy
type: harness:platform:GitxWebhook
properties:
    connectorRef: string
    description: string
    folderPaths:
        - string
    identifier: string
    isEnabled: false
    name: string
    orgId: string
    projectId: string
    repoName: string
    tags:
        - string
Copy

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

ConnectorRef This property is required. string
ConnectorRef to be used to create Gitx webhook.
Identifier
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the resource.
RepoName This property is required. string
Repo Identifier for Gitx webhook.
Description string
Description of the resource.
FolderPaths List<string>
Folder Paths
IsEnabled bool
Flag to enable the webhook
Name string
Name of the resource.
OrgId string
Unique identifier of the organization.
ProjectId string
Unique identifier of the project.
Tags List<string>
Tags to associate with the resource.
ConnectorRef This property is required. string
ConnectorRef to be used to create Gitx webhook.
Identifier
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the resource.
RepoName This property is required. string
Repo Identifier for Gitx webhook.
Description string
Description of the resource.
FolderPaths []string
Folder Paths
IsEnabled bool
Flag to enable the webhook
Name string
Name of the resource.
OrgId string
Unique identifier of the organization.
ProjectId string
Unique identifier of the project.
Tags []string
Tags to associate with the resource.
connectorRef This property is required. String
ConnectorRef to be used to create Gitx webhook.
identifier
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the resource.
repoName This property is required. String
Repo Identifier for Gitx webhook.
description String
Description of the resource.
folderPaths List<String>
Folder Paths
isEnabled Boolean
Flag to enable the webhook
name String
Name of the resource.
orgId String
Unique identifier of the organization.
projectId String
Unique identifier of the project.
tags List<String>
Tags to associate with the resource.
connectorRef This property is required. string
ConnectorRef to be used to create Gitx webhook.
identifier
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the resource.
repoName This property is required. string
Repo Identifier for Gitx webhook.
description string
Description of the resource.
folderPaths string[]
Folder Paths
isEnabled boolean
Flag to enable the webhook
name string
Name of the resource.
orgId string
Unique identifier of the organization.
projectId string
Unique identifier of the project.
tags string[]
Tags to associate with the resource.
connector_ref This property is required. str
ConnectorRef to be used to create Gitx webhook.
identifier
This property is required.
Changes to this property will trigger replacement.
str
Unique identifier of the resource.
repo_name This property is required. str
Repo Identifier for Gitx webhook.
description str
Description of the resource.
folder_paths Sequence[str]
Folder Paths
is_enabled bool
Flag to enable the webhook
name str
Name of the resource.
org_id str
Unique identifier of the organization.
project_id str
Unique identifier of the project.
tags Sequence[str]
Tags to associate with the resource.
connectorRef This property is required. String
ConnectorRef to be used to create Gitx webhook.
identifier
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the resource.
repoName This property is required. String
Repo Identifier for Gitx webhook.
description String
Description of the resource.
folderPaths List<String>
Folder Paths
isEnabled Boolean
Flag to enable the webhook
name String
Name of the resource.
orgId String
Unique identifier of the organization.
projectId String
Unique identifier of the project.
tags List<String>
Tags to associate with the resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GitxWebhook Resource

Get an existing GitxWebhook 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?: GitxWebhookState, opts?: CustomResourceOptions): GitxWebhook
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connector_ref: Optional[str] = None,
        description: Optional[str] = None,
        folder_paths: Optional[Sequence[str]] = None,
        identifier: Optional[str] = None,
        is_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        repo_name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> GitxWebhook
func GetGitxWebhook(ctx *Context, name string, id IDInput, state *GitxWebhookState, opts ...ResourceOption) (*GitxWebhook, error)
public static GitxWebhook Get(string name, Input<string> id, GitxWebhookState? state, CustomResourceOptions? opts = null)
public static GitxWebhook get(String name, Output<String> id, GitxWebhookState state, CustomResourceOptions options)
resources:  _:    type: harness:platform:GitxWebhook    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ConnectorRef string
ConnectorRef to be used to create Gitx webhook.
Description string
Description of the resource.
FolderPaths List<string>
Folder Paths
Identifier Changes to this property will trigger replacement. string
Unique identifier of the resource.
IsEnabled bool
Flag to enable the webhook
Name string
Name of the resource.
OrgId string
Unique identifier of the organization.
ProjectId string
Unique identifier of the project.
RepoName string
Repo Identifier for Gitx webhook.
Tags List<string>
Tags to associate with the resource.
ConnectorRef string
ConnectorRef to be used to create Gitx webhook.
Description string
Description of the resource.
FolderPaths []string
Folder Paths
Identifier Changes to this property will trigger replacement. string
Unique identifier of the resource.
IsEnabled bool
Flag to enable the webhook
Name string
Name of the resource.
OrgId string
Unique identifier of the organization.
ProjectId string
Unique identifier of the project.
RepoName string
Repo Identifier for Gitx webhook.
Tags []string
Tags to associate with the resource.
connectorRef String
ConnectorRef to be used to create Gitx webhook.
description String
Description of the resource.
folderPaths List<String>
Folder Paths
identifier Changes to this property will trigger replacement. String
Unique identifier of the resource.
isEnabled Boolean
Flag to enable the webhook
name String
Name of the resource.
orgId String
Unique identifier of the organization.
projectId String
Unique identifier of the project.
repoName String
Repo Identifier for Gitx webhook.
tags List<String>
Tags to associate with the resource.
connectorRef string
ConnectorRef to be used to create Gitx webhook.
description string
Description of the resource.
folderPaths string[]
Folder Paths
identifier Changes to this property will trigger replacement. string
Unique identifier of the resource.
isEnabled boolean
Flag to enable the webhook
name string
Name of the resource.
orgId string
Unique identifier of the organization.
projectId string
Unique identifier of the project.
repoName string
Repo Identifier for Gitx webhook.
tags string[]
Tags to associate with the resource.
connector_ref str
ConnectorRef to be used to create Gitx webhook.
description str
Description of the resource.
folder_paths Sequence[str]
Folder Paths
identifier Changes to this property will trigger replacement. str
Unique identifier of the resource.
is_enabled bool
Flag to enable the webhook
name str
Name of the resource.
org_id str
Unique identifier of the organization.
project_id str
Unique identifier of the project.
repo_name str
Repo Identifier for Gitx webhook.
tags Sequence[str]
Tags to associate with the resource.
connectorRef String
ConnectorRef to be used to create Gitx webhook.
description String
Description of the resource.
folderPaths List<String>
Folder Paths
identifier Changes to this property will trigger replacement. String
Unique identifier of the resource.
isEnabled Boolean
Flag to enable the webhook
name String
Name of the resource.
orgId String
Unique identifier of the organization.
projectId String
Unique identifier of the project.
repoName String
Repo Identifier for Gitx webhook.
tags List<String>
Tags to associate with the resource.

Import

Import an Account level Webhook

$ pulumi import harness:platform/gitxWebhook:GitxWebhook example <webhook_identifier>
Copy

Import an Org level Webhook

$ pulumi import harness:platform/gitxWebhook:GitxWebhook example <webhook_identifier>/<org_id>/
Copy

Import a Project level Webhook

$ pulumi import harness:platform/gitxWebhook:GitxWebhook example <webhook_identifier>/<org_id>/<project_id>
Copy

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

Package Details

Repository
harness pulumi/pulumi-harness
License
Apache-2.0
Notes
This Pulumi package is based on the harness Terraform Provider.
Harness v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness