Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. DockerCustomWebhook
artifactory v8.8.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-artifactory

artifactory.DockerCustomWebhook

Explore with Pulumi AI

artifactory logo
artifactory v8.8.0 published on Friday, Mar 7, 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_docker_local = new artifactory.DockerV2Repository("my-docker-local", {key: "my-docker-local"});
const docker_custom_webhook = new artifactory.DockerCustomWebhook("docker-custom-webhook", {
    key: "docker-custom_webhook",
    eventTypes: [
        "pushed",
        "deleted",
        "promoted",
    ],
    criteria: {
        anyLocal: true,
        anyRemote: false,
        repoKeys: [my_docker_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_docker_local],
});

    import pulumi
import pulumi_artifactory as artifactory

my_docker_local = artifactory.DockerV2Repository("my-docker-local", key="my-docker-local")
docker_custom_webhook = artifactory.DockerCustomWebhook("docker-custom-webhook",
    key="docker-custom_webhook",
    event_types=[
        "pushed",
        "deleted",
        "promoted",
    ],
    criteria={
        "any_local": True,
        "any_remote": False,
        "repo_keys": [my_docker_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_docker_local]))

    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_docker_local, err := artifactory.NewDockerV2Repository(ctx, "my-docker-local", &artifactory.DockerV2RepositoryArgs{
			Key: pulumi.String("my-docker-local"),
		})
		if err != nil {
			return err
		}
		_, err = artifactory.NewDockerCustomWebhook(ctx, "docker-custom-webhook", &artifactory.DockerCustomWebhookArgs{
			Key: pulumi.String("docker-custom_webhook"),
			EventTypes: pulumi.StringArray{
				pulumi.String("pushed"),
				pulumi.String("deleted"),
				pulumi.String("promoted"),
			},
			Criteria: &artifactory.DockerCustomWebhookCriteriaArgs{
				AnyLocal:  pulumi.Bool(true),
				AnyRemote: pulumi.Bool(false),
				RepoKeys: pulumi.StringArray{
					my_docker_local.Key,
				},
				IncludePatterns: pulumi.StringArray{
					pulumi.String("foo/**"),
				},
				ExcludePatterns: pulumi.StringArray{
					pulumi.String("bar/**"),
				},
			},
			Handlers: artifactory.DockerCustomWebhookHandlerArray{
				&artifactory.DockerCustomWebhookHandlerArgs{
					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_docker_local,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    var my_docker_local = new Artifactory.DockerV2Repository("my-docker-local", new()
    {
        Key = "my-docker-local",
    });

    var docker_custom_webhook = new Artifactory.DockerCustomWebhook("docker-custom-webhook", new()
    {
        Key = "docker-custom_webhook",
        EventTypes = new[]
        {
            "pushed",
            "deleted",
            "promoted",
        },
        Criteria = new Artifactory.Inputs.DockerCustomWebhookCriteriaArgs
        {
            AnyLocal = true,
            AnyRemote = false,
            RepoKeys = new[]
            {
                my_docker_local.Key,
            },
            IncludePatterns = new[]
            {
                "foo/**",
            },
            ExcludePatterns = new[]
            {
                "bar/**",
            },
        },
        Handlers = new[]
        {
            new Artifactory.Inputs.DockerCustomWebhookHandlerArgs
            {
                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_docker_local,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.DockerV2Repository;
import com.pulumi.artifactory.DockerV2RepositoryArgs;
import com.pulumi.artifactory.DockerCustomWebhook;
import com.pulumi.artifactory.DockerCustomWebhookArgs;
import com.pulumi.artifactory.inputs.DockerCustomWebhookCriteriaArgs;
import com.pulumi.artifactory.inputs.DockerCustomWebhookHandlerArgs;
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_docker_local = new DockerV2Repository("my-docker-local", DockerV2RepositoryArgs.builder()
            .key("my-docker-local")
            .build());

        var docker_custom_webhook = new DockerCustomWebhook("docker-custom-webhook", DockerCustomWebhookArgs.builder()
            .key("docker-custom_webhook")
            .eventTypes(            
                "pushed",
                "deleted",
                "promoted")
            .criteria(DockerCustomWebhookCriteriaArgs.builder()
                .anyLocal(true)
                .anyRemote(false)
                .repoKeys(my_docker_local.key())
                .includePatterns("foo/**")
                .excludePatterns("bar/**")
                .build())
            .handlers(DockerCustomWebhookHandlerArgs.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_docker_local)
                .build());

    }
}

    resources:
  my-docker-local:
    type: artifactory:DockerV2Repository
    properties:
      key: my-docker-local
  docker-custom-webhook:
    type: artifactory:DockerCustomWebhook
    properties:
      key: docker-custom_webhook
      eventTypes:
        - pushed
        - deleted
        - promoted
      criteria:
        anyLocal: true
        anyRemote: false
        repoKeys:
          - ${["my-docker-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-docker-local"]}

    Create DockerCustomWebhook Resource

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

    Constructor syntax

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

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

    type: artifactory:DockerCustomWebhook
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 DockerCustomWebhookArgs
    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 DockerCustomWebhookArgs
    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 DockerCustomWebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DockerCustomWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DockerCustomWebhookArgs
    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 dockerCustomWebhookResource = new Artifactory.DockerCustomWebhook("dockerCustomWebhookResource", new()
{
    EventTypes = new[]
    {
        "string",
    },
    Key = "string",
    Criteria = new Artifactory.Inputs.DockerCustomWebhookCriteriaArgs
    {
        AnyFederated = false,
        AnyLocal = false,
        AnyRemote = false,
        RepoKeys = new[]
        {
            "string",
        },
        ExcludePatterns = new[]
        {
            "string",
        },
        IncludePatterns = new[]
        {
            "string",
        },
    },
    Description = "string",
    Enabled = false,
    Handlers = new[]
    {
        new Artifactory.Inputs.DockerCustomWebhookHandlerArgs
        {
            Url = "string",
            HttpHeaders = 
            {
                { "string", "string" },
            },
            Method = "string",
            Payload = "string",
            Proxy = "string",
            Secrets = 
            {
                { "string", "string" },
            },
        },
    },
});

    example, err := artifactory.NewDockerCustomWebhook(ctx, "dockerCustomWebhookResource", &artifactory.DockerCustomWebhookArgs{
	EventTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Key: pulumi.String("string"),
	Criteria: &artifactory.DockerCustomWebhookCriteriaArgs{
		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.DockerCustomWebhookHandlerArray{
		&artifactory.DockerCustomWebhookHandlerArgs{
			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"),
			},
		},
	},
})

    var dockerCustomWebhookResource = new DockerCustomWebhook("dockerCustomWebhookResource", DockerCustomWebhookArgs.builder()
    .eventTypes("string")
    .key("string")
    .criteria(DockerCustomWebhookCriteriaArgs.builder()
        .anyFederated(false)
        .anyLocal(false)
        .anyRemote(false)
        .repoKeys("string")
        .excludePatterns("string")
        .includePatterns("string")
        .build())
    .description("string")
    .enabled(false)
    .handlers(DockerCustomWebhookHandlerArgs.builder()
        .url("string")
        .httpHeaders(Map.of("string", "string"))
        .method("string")
        .payload("string")
        .proxy("string")
        .secrets(Map.of("string", "string"))
        .build())
    .build());

    docker_custom_webhook_resource = artifactory.DockerCustomWebhook("dockerCustomWebhookResource",
    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",
        },
    }])

    const dockerCustomWebhookResource = new artifactory.DockerCustomWebhook("dockerCustomWebhookResource", {
    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",
        },
    }],
});

    type: artifactory:DockerCustomWebhook
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

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

    EventTypes List<string>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: pushed, deleted, promoted.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Criteria DockerCustomWebhookCriteria
    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<DockerCustomWebhookHandler>
    At least one is required.
    EventTypes []string
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: pushed, deleted, promoted.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Criteria DockerCustomWebhookCriteriaArgs
    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 []DockerCustomWebhookHandlerArgs
    At least one is required.
    eventTypes List<String>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: pushed, deleted, promoted.
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DockerCustomWebhookCriteria
    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<DockerCustomWebhookHandler>
    At least one is required.
    eventTypes string[]
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: pushed, deleted, promoted.
    key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DockerCustomWebhookCriteria
    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 DockerCustomWebhookHandler[]
    At least one is required.
    event_types Sequence[str]
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: pushed, deleted, promoted.
    key str
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DockerCustomWebhookCriteriaArgs
    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[DockerCustomWebhookHandlerArgs]
    At least one is required.
    eventTypes List<String>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: pushed, deleted, promoted.
    key 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 DockerCustomWebhook 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 DockerCustomWebhook Resource

    Get an existing DockerCustomWebhook 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?: DockerCustomWebhookState, opts?: CustomResourceOptions): DockerCustomWebhook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        criteria: Optional[DockerCustomWebhookCriteriaArgs] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        event_types: Optional[Sequence[str]] = None,
        handlers: Optional[Sequence[DockerCustomWebhookHandlerArgs]] = None,
        key: Optional[str] = None) -> DockerCustomWebhook
    func GetDockerCustomWebhook(ctx *Context, name string, id IDInput, state *DockerCustomWebhookState, opts ...ResourceOption) (*DockerCustomWebhook, error)
    public static DockerCustomWebhook Get(string name, Input<string> id, DockerCustomWebhookState? state, CustomResourceOptions? opts = null)
    public static DockerCustomWebhook get(String name, Output<String> id, DockerCustomWebhookState state, CustomResourceOptions options)
    resources:  _:    type: artifactory:DockerCustomWebhook    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:
    Criteria DockerCustomWebhookCriteria
    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: pushed, deleted, promoted.
    Handlers List<DockerCustomWebhookHandler>
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Criteria DockerCustomWebhookCriteriaArgs
    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: pushed, deleted, promoted.
    Handlers []DockerCustomWebhookHandlerArgs
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DockerCustomWebhookCriteria
    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: pushed, deleted, promoted.
    handlers List<DockerCustomWebhookHandler>
    At least one is required.
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DockerCustomWebhookCriteria
    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: pushed, deleted, promoted.
    handlers DockerCustomWebhookHandler[]
    At least one is required.
    key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DockerCustomWebhookCriteriaArgs
    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: pushed, deleted, promoted.
    handlers Sequence[DockerCustomWebhookHandlerArgs]
    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: pushed, deleted, promoted.
    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

    DockerCustomWebhookCriteria, DockerCustomWebhookCriteriaArgs

    AnyFederated bool
    Trigger on any federated repositories
    AnyLocal bool
    Trigger on any local repo.
    AnyRemote bool
    Trigger on any remote repo.
    RepoKeys 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 bool
    Trigger on any federated repositories
    AnyLocal bool
    Trigger on any local repo.
    AnyRemote bool
    Trigger on any remote repo.
    RepoKeys []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 Boolean
    Trigger on any federated repositories
    anyLocal Boolean
    Trigger on any local repo.
    anyRemote Boolean
    Trigger on any remote repo.
    repoKeys 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 boolean
    Trigger on any federated repositories
    anyLocal boolean
    Trigger on any local repo.
    anyRemote boolean
    Trigger on any remote repo.
    repoKeys 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 bool
    Trigger on any federated repositories
    any_local bool
    Trigger on any local repo.
    any_remote bool
    Trigger on any remote repo.
    repo_keys 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 Boolean
    Trigger on any federated repositories
    anyLocal Boolean
    Trigger on any local repo.
    anyRemote Boolean
    Trigger on any remote repo.
    repoKeys 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/**.

    DockerCustomWebhookHandler, DockerCustomWebhookHandlerArgs

    Url 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 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 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 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 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 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 logo
    artifactory v8.8.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-artifactory