Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. ArtifactPropertyCustomWebhook
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory

artifactory.ArtifactPropertyCustomWebhook

Explore with Pulumi AI

artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory

Provides an Artifactory custom webhook resource. This can be used to register and manage Artifactory webhook subscription which enables you to be notified or notify other users when such events take place in Artifactory.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as artifactory from "@pulumi/artifactory";

const my_generic_local = new artifactory.LocalGenericRepository("my-generic-local", {key: "my-generic-local"});
const artifact_custom_webhook = new artifactory.ArtifactPropertyCustomWebhook("artifact-custom-webhook", {
    key: "artifact-property-custom-webhook",
    eventTypes: [
        "added",
        "deleted",
    ],
    criteria: {
        anyLocal: true,
        anyRemote: false,
        repoKeys: [my_generic_local.key],
        includePatterns: ["foo/**"],
        excludePatterns: ["bar/**"],
    },
    handlers: [{
        url: "https://tempurl.org",
        method: "POST",
        secrets: {
            secretName1: "value1",
            secretName2: "value2",
        },
        httpHeaders: {
            headerName1: "value1",
            headerName2: "value2",
        },
        payload: "{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }",
    }],
}, {
    dependsOn: [my_generic_local],
});
Copy
import pulumi
import pulumi_artifactory as artifactory

my_generic_local = artifactory.LocalGenericRepository("my-generic-local", key="my-generic-local")
artifact_custom_webhook = artifactory.ArtifactPropertyCustomWebhook("artifact-custom-webhook",
    key="artifact-property-custom-webhook",
    event_types=[
        "added",
        "deleted",
    ],
    criteria={
        "any_local": True,
        "any_remote": False,
        "repo_keys": [my_generic_local.key],
        "include_patterns": ["foo/**"],
        "exclude_patterns": ["bar/**"],
    },
    handlers=[{
        "url": "https://tempurl.org",
        "method": "POST",
        "secrets": {
            "secretName1": "value1",
            "secretName2": "value2",
        },
        "http_headers": {
            "headerName1": "value1",
            "headerName2": "value2",
        },
        "payload": "{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }",
    }],
    opts = pulumi.ResourceOptions(depends_on=[my_generic_local]))
Copy
package main

import (
	"github.com/pulumi/pulumi-artifactory/sdk/v8/go/artifactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		my_generic_local, err := artifactory.NewLocalGenericRepository(ctx, "my-generic-local", &artifactory.LocalGenericRepositoryArgs{
			Key: pulumi.String("my-generic-local"),
		})
		if err != nil {
			return err
		}
		_, err = artifactory.NewArtifactPropertyCustomWebhook(ctx, "artifact-custom-webhook", &artifactory.ArtifactPropertyCustomWebhookArgs{
			Key: pulumi.String("artifact-property-custom-webhook"),
			EventTypes: pulumi.StringArray{
				pulumi.String("added"),
				pulumi.String("deleted"),
			},
			Criteria: &artifactory.ArtifactPropertyCustomWebhookCriteriaArgs{
				AnyLocal:  pulumi.Bool(true),
				AnyRemote: pulumi.Bool(false),
				RepoKeys: pulumi.StringArray{
					my_generic_local.Key,
				},
				IncludePatterns: pulumi.StringArray{
					pulumi.String("foo/**"),
				},
				ExcludePatterns: pulumi.StringArray{
					pulumi.String("bar/**"),
				},
			},
			Handlers: artifactory.ArtifactPropertyCustomWebhookHandlerArray{
				&artifactory.ArtifactPropertyCustomWebhookHandlerArgs{
					Url:    pulumi.String("https://tempurl.org"),
					Method: pulumi.String("POST"),
					Secrets: pulumi.StringMap{
						"secretName1": pulumi.String("value1"),
						"secretName2": pulumi.String("value2"),
					},
					HttpHeaders: pulumi.StringMap{
						"headerName1": pulumi.String("value1"),
						"headerName2": pulumi.String("value2"),
					},
					Payload: pulumi.String("{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }"),
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			my_generic_local,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    var my_generic_local = new Artifactory.LocalGenericRepository("my-generic-local", new()
    {
        Key = "my-generic-local",
    });

    var artifact_custom_webhook = new Artifactory.ArtifactPropertyCustomWebhook("artifact-custom-webhook", new()
    {
        Key = "artifact-property-custom-webhook",
        EventTypes = new[]
        {
            "added",
            "deleted",
        },
        Criteria = new Artifactory.Inputs.ArtifactPropertyCustomWebhookCriteriaArgs
        {
            AnyLocal = true,
            AnyRemote = false,
            RepoKeys = new[]
            {
                my_generic_local.Key,
            },
            IncludePatterns = new[]
            {
                "foo/**",
            },
            ExcludePatterns = new[]
            {
                "bar/**",
            },
        },
        Handlers = new[]
        {
            new Artifactory.Inputs.ArtifactPropertyCustomWebhookHandlerArgs
            {
                Url = "https://tempurl.org",
                Method = "POST",
                Secrets = 
                {
                    { "secretName1", "value1" },
                    { "secretName2", "value2" },
                },
                HttpHeaders = 
                {
                    { "headerName1", "value1" },
                    { "headerName2", "value2" },
                },
                Payload = "{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }",
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            my_generic_local,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.LocalGenericRepository;
import com.pulumi.artifactory.LocalGenericRepositoryArgs;
import com.pulumi.artifactory.ArtifactPropertyCustomWebhook;
import com.pulumi.artifactory.ArtifactPropertyCustomWebhookArgs;
import com.pulumi.artifactory.inputs.ArtifactPropertyCustomWebhookCriteriaArgs;
import com.pulumi.artifactory.inputs.ArtifactPropertyCustomWebhookHandlerArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var my_generic_local = new LocalGenericRepository("my-generic-local", LocalGenericRepositoryArgs.builder()
            .key("my-generic-local")
            .build());

        var artifact_custom_webhook = new ArtifactPropertyCustomWebhook("artifact-custom-webhook", ArtifactPropertyCustomWebhookArgs.builder()
            .key("artifact-property-custom-webhook")
            .eventTypes(            
                "added",
                "deleted")
            .criteria(ArtifactPropertyCustomWebhookCriteriaArgs.builder()
                .anyLocal(true)
                .anyRemote(false)
                .repoKeys(my_generic_local.key())
                .includePatterns("foo/**")
                .excludePatterns("bar/**")
                .build())
            .handlers(ArtifactPropertyCustomWebhookHandlerArgs.builder()
                .url("https://tempurl.org")
                .method("POST")
                .secrets(Map.ofEntries(
                    Map.entry("secretName1", "value1"),
                    Map.entry("secretName2", "value2")
                ))
                .httpHeaders(Map.ofEntries(
                    Map.entry("headerName1", "value1"),
                    Map.entry("headerName2", "value2")
                ))
                .payload("{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(my_generic_local)
                .build());

    }
}
Copy
resources:
  my-generic-local:
    type: artifactory:LocalGenericRepository
    properties:
      key: my-generic-local
  artifact-custom-webhook:
    type: artifactory:ArtifactPropertyCustomWebhook
    properties:
      key: artifact-property-custom-webhook
      eventTypes:
        - added
        - deleted
      criteria:
        anyLocal: true
        anyRemote: false
        repoKeys:
          - ${["my-generic-local"].key}
        includePatterns:
          - foo/**
        excludePatterns:
          - bar/**
      handlers:
        - url: https://tempurl.org
          method: POST
          secrets:
            secretName1: value1
            secretName2: value2
          httpHeaders:
            headerName1: value1
            headerName2: value2
          payload: '{ "ref": "main" , "inputs": { "artifact_path": "test-repo/repo-path" } }'
    options:
      dependsOn:
        - ${["my-generic-local"]}
Copy

Create ArtifactPropertyCustomWebhook Resource

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

Constructor syntax

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

@overload
def ArtifactPropertyCustomWebhook(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  event_types: Optional[Sequence[str]] = None,
                                  key: Optional[str] = None,
                                  criteria: Optional[ArtifactPropertyCustomWebhookCriteriaArgs] = None,
                                  description: Optional[str] = None,
                                  enabled: Optional[bool] = None,
                                  handlers: Optional[Sequence[ArtifactPropertyCustomWebhookHandlerArgs]] = None)
func NewArtifactPropertyCustomWebhook(ctx *Context, name string, args ArtifactPropertyCustomWebhookArgs, opts ...ResourceOption) (*ArtifactPropertyCustomWebhook, error)
public ArtifactPropertyCustomWebhook(string name, ArtifactPropertyCustomWebhookArgs args, CustomResourceOptions? opts = null)
public ArtifactPropertyCustomWebhook(String name, ArtifactPropertyCustomWebhookArgs args)
public ArtifactPropertyCustomWebhook(String name, ArtifactPropertyCustomWebhookArgs args, CustomResourceOptions options)

type: artifactory:ArtifactPropertyCustomWebhook
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. ArtifactPropertyCustomWebhookArgs
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. ArtifactPropertyCustomWebhookArgs
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. ArtifactPropertyCustomWebhookArgs
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. ArtifactPropertyCustomWebhookArgs
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. ArtifactPropertyCustomWebhookArgs
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 artifactPropertyCustomWebhookResource = new Artifactory.ArtifactPropertyCustomWebhook("artifactPropertyCustomWebhookResource", new()
{
    EventTypes = new[]
    {
        "string",
    },
    Key = "string",
    Criteria = new Artifactory.Inputs.ArtifactPropertyCustomWebhookCriteriaArgs
    {
        AnyFederated = false,
        AnyLocal = false,
        AnyRemote = false,
        RepoKeys = new[]
        {
            "string",
        },
        ExcludePatterns = new[]
        {
            "string",
        },
        IncludePatterns = new[]
        {
            "string",
        },
    },
    Description = "string",
    Enabled = false,
    Handlers = new[]
    {
        new Artifactory.Inputs.ArtifactPropertyCustomWebhookHandlerArgs
        {
            Url = "string",
            HttpHeaders = 
            {
                { "string", "string" },
            },
            Method = "string",
            Payload = "string",
            Proxy = "string",
            Secrets = 
            {
                { "string", "string" },
            },
        },
    },
});
Copy
example, err := artifactory.NewArtifactPropertyCustomWebhook(ctx, "artifactPropertyCustomWebhookResource", &artifactory.ArtifactPropertyCustomWebhookArgs{
	EventTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Key: pulumi.String("string"),
	Criteria: &artifactory.ArtifactPropertyCustomWebhookCriteriaArgs{
		AnyFederated: pulumi.Bool(false),
		AnyLocal:     pulumi.Bool(false),
		AnyRemote:    pulumi.Bool(false),
		RepoKeys: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExcludePatterns: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludePatterns: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Handlers: artifactory.ArtifactPropertyCustomWebhookHandlerArray{
		&artifactory.ArtifactPropertyCustomWebhookHandlerArgs{
			Url: pulumi.String("string"),
			HttpHeaders: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Method:  pulumi.String("string"),
			Payload: pulumi.String("string"),
			Proxy:   pulumi.String("string"),
			Secrets: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
})
Copy
var artifactPropertyCustomWebhookResource = new ArtifactPropertyCustomWebhook("artifactPropertyCustomWebhookResource", ArtifactPropertyCustomWebhookArgs.builder()
    .eventTypes("string")
    .key("string")
    .criteria(ArtifactPropertyCustomWebhookCriteriaArgs.builder()
        .anyFederated(false)
        .anyLocal(false)
        .anyRemote(false)
        .repoKeys("string")
        .excludePatterns("string")
        .includePatterns("string")
        .build())
    .description("string")
    .enabled(false)
    .handlers(ArtifactPropertyCustomWebhookHandlerArgs.builder()
        .url("string")
        .httpHeaders(Map.of("string", "string"))
        .method("string")
        .payload("string")
        .proxy("string")
        .secrets(Map.of("string", "string"))
        .build())
    .build());
Copy
artifact_property_custom_webhook_resource = artifactory.ArtifactPropertyCustomWebhook("artifactPropertyCustomWebhookResource",
    event_types=["string"],
    key="string",
    criteria={
        "any_federated": False,
        "any_local": False,
        "any_remote": False,
        "repo_keys": ["string"],
        "exclude_patterns": ["string"],
        "include_patterns": ["string"],
    },
    description="string",
    enabled=False,
    handlers=[{
        "url": "string",
        "http_headers": {
            "string": "string",
        },
        "method": "string",
        "payload": "string",
        "proxy": "string",
        "secrets": {
            "string": "string",
        },
    }])
Copy
const artifactPropertyCustomWebhookResource = new artifactory.ArtifactPropertyCustomWebhook("artifactPropertyCustomWebhookResource", {
    eventTypes: ["string"],
    key: "string",
    criteria: {
        anyFederated: false,
        anyLocal: false,
        anyRemote: false,
        repoKeys: ["string"],
        excludePatterns: ["string"],
        includePatterns: ["string"],
    },
    description: "string",
    enabled: false,
    handlers: [{
        url: "string",
        httpHeaders: {
            string: "string",
        },
        method: "string",
        payload: "string",
        proxy: "string",
        secrets: {
            string: "string",
        },
    }],
});
Copy
type: artifactory:ArtifactPropertyCustomWebhook
properties:
    criteria:
        anyFederated: false
        anyLocal: false
        anyRemote: false
        excludePatterns:
            - string
        includePatterns:
            - string
        repoKeys:
            - string
    description: string
    enabled: false
    eventTypes:
        - string
    handlers:
        - httpHeaders:
            string: string
          method: string
          payload: string
          proxy: string
          secrets:
            string: string
          url: string
    key: string
Copy

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

EventTypes This property is required. List<string>
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
Key This property is required. string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
Criteria ArtifactPropertyCustomWebhookCriteria
Specifies where the webhook will be applied on which repositories.
Description string
Webhook description. Max length 1000 characters.
Enabled bool
Status of webhook. Default to true.
Handlers List<ArtifactPropertyCustomWebhookHandler>
At least one is required.
EventTypes This property is required. []string
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
Key This property is required. string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
Criteria ArtifactPropertyCustomWebhookCriteriaArgs
Specifies where the webhook will be applied on which repositories.
Description string
Webhook description. Max length 1000 characters.
Enabled bool
Status of webhook. Default to true.
Handlers []ArtifactPropertyCustomWebhookHandlerArgs
At least one is required.
eventTypes This property is required. List<String>
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
key This property is required. String
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria ArtifactPropertyCustomWebhookCriteria
Specifies where the webhook will be applied on which repositories.
description String
Webhook description. Max length 1000 characters.
enabled Boolean
Status of webhook. Default to true.
handlers List<ArtifactPropertyCustomWebhookHandler>
At least one is required.
eventTypes This property is required. string[]
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
key This property is required. string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria ArtifactPropertyCustomWebhookCriteria
Specifies where the webhook will be applied on which repositories.
description string
Webhook description. Max length 1000 characters.
enabled boolean
Status of webhook. Default to true.
handlers ArtifactPropertyCustomWebhookHandler[]
At least one is required.
event_types This property is required. Sequence[str]
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
key This property is required. str
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria ArtifactPropertyCustomWebhookCriteriaArgs
Specifies where the webhook will be applied on which repositories.
description str
Webhook description. Max length 1000 characters.
enabled bool
Status of webhook. Default to true.
handlers Sequence[ArtifactPropertyCustomWebhookHandlerArgs]
At least one is required.
eventTypes This property is required. List<String>
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
key This property is required. String
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria Property Map
Specifies where the webhook will be applied on which repositories.
description String
Webhook description. Max length 1000 characters.
enabled Boolean
Status of webhook. Default to true.
handlers List<Property Map>
At least one is required.

Outputs

All input properties are implicitly available as output properties. Additionally, the ArtifactPropertyCustomWebhook 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 ArtifactPropertyCustomWebhook Resource

Get an existing ArtifactPropertyCustomWebhook 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?: ArtifactPropertyCustomWebhookState, opts?: CustomResourceOptions): ArtifactPropertyCustomWebhook
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        criteria: Optional[ArtifactPropertyCustomWebhookCriteriaArgs] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        event_types: Optional[Sequence[str]] = None,
        handlers: Optional[Sequence[ArtifactPropertyCustomWebhookHandlerArgs]] = None,
        key: Optional[str] = None) -> ArtifactPropertyCustomWebhook
func GetArtifactPropertyCustomWebhook(ctx *Context, name string, id IDInput, state *ArtifactPropertyCustomWebhookState, opts ...ResourceOption) (*ArtifactPropertyCustomWebhook, error)
public static ArtifactPropertyCustomWebhook Get(string name, Input<string> id, ArtifactPropertyCustomWebhookState? state, CustomResourceOptions? opts = null)
public static ArtifactPropertyCustomWebhook get(String name, Output<String> id, ArtifactPropertyCustomWebhookState state, CustomResourceOptions options)
resources:  _:    type: artifactory:ArtifactPropertyCustomWebhook    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:
Criteria ArtifactPropertyCustomWebhookCriteria
Specifies where the webhook will be applied on which repositories.
Description string
Webhook description. Max length 1000 characters.
Enabled bool
Status of webhook. Default to true.
EventTypes List<string>
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
Handlers List<ArtifactPropertyCustomWebhookHandler>
At least one is required.
Key string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
Criteria ArtifactPropertyCustomWebhookCriteriaArgs
Specifies where the webhook will be applied on which repositories.
Description string
Webhook description. Max length 1000 characters.
Enabled bool
Status of webhook. Default to true.
EventTypes []string
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
Handlers []ArtifactPropertyCustomWebhookHandlerArgs
At least one is required.
Key string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria ArtifactPropertyCustomWebhookCriteria
Specifies where the webhook will be applied on which repositories.
description String
Webhook description. Max length 1000 characters.
enabled Boolean
Status of webhook. Default to true.
eventTypes List<String>
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
handlers List<ArtifactPropertyCustomWebhookHandler>
At least one is required.
key String
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria ArtifactPropertyCustomWebhookCriteria
Specifies where the webhook will be applied on which repositories.
description string
Webhook description. Max length 1000 characters.
enabled boolean
Status of webhook. Default to true.
eventTypes string[]
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
handlers ArtifactPropertyCustomWebhookHandler[]
At least one is required.
key string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria ArtifactPropertyCustomWebhookCriteriaArgs
Specifies where the webhook will be applied on which repositories.
description str
Webhook description. Max length 1000 characters.
enabled bool
Status of webhook. Default to true.
event_types Sequence[str]
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
handlers Sequence[ArtifactPropertyCustomWebhookHandlerArgs]
At least one is required.
key str
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria Property Map
Specifies where the webhook will be applied on which repositories.
description String
Webhook description. Max length 1000 characters.
enabled Boolean
Status of webhook. Default to true.
eventTypes List<String>
List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
handlers List<Property Map>
At least one is required.
key String
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.

Supporting Types

ArtifactPropertyCustomWebhookCriteria
, ArtifactPropertyCustomWebhookCriteriaArgs

AnyFederated This property is required. bool
Trigger on any federated repositories
AnyLocal This property is required. bool
Trigger on any local repo.
AnyRemote This property is required. bool
Trigger on any remote repo.
RepoKeys This property is required. List<string>
Trigger on this list of repo keys.
ExcludePatterns List<string>
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
IncludePatterns List<string>
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
AnyFederated This property is required. bool
Trigger on any federated repositories
AnyLocal This property is required. bool
Trigger on any local repo.
AnyRemote This property is required. bool
Trigger on any remote repo.
RepoKeys This property is required. []string
Trigger on this list of repo keys.
ExcludePatterns []string
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
IncludePatterns []string
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
anyFederated This property is required. Boolean
Trigger on any federated repositories
anyLocal This property is required. Boolean
Trigger on any local repo.
anyRemote This property is required. Boolean
Trigger on any remote repo.
repoKeys This property is required. List<String>
Trigger on this list of repo keys.
excludePatterns List<String>
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
includePatterns List<String>
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
anyFederated This property is required. boolean
Trigger on any federated repositories
anyLocal This property is required. boolean
Trigger on any local repo.
anyRemote This property is required. boolean
Trigger on any remote repo.
repoKeys This property is required. string[]
Trigger on this list of repo keys.
excludePatterns string[]
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
includePatterns string[]
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
any_federated This property is required. bool
Trigger on any federated repositories
any_local This property is required. bool
Trigger on any local repo.
any_remote This property is required. bool
Trigger on any remote repo.
repo_keys This property is required. Sequence[str]
Trigger on this list of repo keys.
exclude_patterns Sequence[str]
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
include_patterns Sequence[str]
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
anyFederated This property is required. Boolean
Trigger on any federated repositories
anyLocal This property is required. Boolean
Trigger on any local repo.
anyRemote This property is required. Boolean
Trigger on any remote repo.
repoKeys This property is required. List<String>
Trigger on this list of repo keys.
excludePatterns List<String>
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
includePatterns List<String>
Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.

ArtifactPropertyCustomWebhookHandler
, ArtifactPropertyCustomWebhookHandlerArgs

Url This property is required. string
Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
HttpHeaders Dictionary<string, string>
HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
Method string
Specifies the HTTP method for the URL that the Webhook invokes. Allowed values are: GET, POST, PUT, PATCH, DELETE.
Payload string
This attribute is used to build the request body. Used in custom webhooks
Proxy string
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
Secrets Dictionary<string, string>
Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
Url This property is required. string
Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
HttpHeaders map[string]string
HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
Method string
Specifies the HTTP method for the URL that the Webhook invokes. Allowed values are: GET, POST, PUT, PATCH, DELETE.
Payload string
This attribute is used to build the request body. Used in custom webhooks
Proxy string
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
Secrets map[string]string
Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
url This property is required. String
Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
httpHeaders Map<String,String>
HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
method String
Specifies the HTTP method for the URL that the Webhook invokes. Allowed values are: GET, POST, PUT, PATCH, DELETE.
payload String
This attribute is used to build the request body. Used in custom webhooks
proxy String
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
secrets Map<String,String>
Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
url This property is required. string
Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
httpHeaders {[key: string]: string}
HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
method string
Specifies the HTTP method for the URL that the Webhook invokes. Allowed values are: GET, POST, PUT, PATCH, DELETE.
payload string
This attribute is used to build the request body. Used in custom webhooks
proxy string
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
secrets {[key: string]: string}
Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
url This property is required. str
Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
http_headers Mapping[str, str]
HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
method str
Specifies the HTTP method for the URL that the Webhook invokes. Allowed values are: GET, POST, PUT, PATCH, DELETE.
payload str
This attribute is used to build the request body. Used in custom webhooks
proxy str
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
secrets Mapping[str, str]
Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
url This property is required. String
Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
httpHeaders Map<String>
HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
method String
Specifies the HTTP method for the URL that the Webhook invokes. Allowed values are: GET, POST, PUT, PATCH, DELETE.
payload String
This attribute is used to build the request body. Used in custom webhooks
proxy String
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
secrets Map<String>
Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:

Package Details

Repository
artifactory pulumi/pulumi-artifactory
License
Apache-2.0
Notes
This Pulumi package is based on the artifactory Terraform Provider.
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory