1. Packages
  2. Artifactory Provider
  3. API Docs
  4. DockerWebhook
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi

artifactory.DockerWebhook

Explore with Pulumi AI

Provides an Artifactory 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_webhook = new artifactory.DockerWebhook("docker-webhook", {
    key: "docker-webhook",
    eventTypes: [
        "pushed",
        "deleted",
        "promoted",
    ],
    criteria: {
        anyLocal: true,
        anyRemote: false,
        anyFederated: false,
        repoKeys: [my_docker_local.key],
        includePatterns: ["foo/**"],
        excludePatterns: ["bar/**"],
    },
    handlers: [{
        url: "http://tempurl.org/webhook",
        secret: "some-secret",
        proxy: "proxy-key",
        customHttpHeaders: {
            "header-1": "value-1",
            "header-2": "value-2",
        },
    }],
}, {
    dependsOn: [my_docker_local],
});
Copy
import pulumi
import pulumi_artifactory as artifactory

my_docker_local = artifactory.DockerV2Repository("my-docker-local", key="my-docker-local")
docker_webhook = artifactory.DockerWebhook("docker-webhook",
    key="docker-webhook",
    event_types=[
        "pushed",
        "deleted",
        "promoted",
    ],
    criteria={
        "any_local": True,
        "any_remote": False,
        "any_federated": False,
        "repo_keys": [my_docker_local.key],
        "include_patterns": ["foo/**"],
        "exclude_patterns": ["bar/**"],
    },
    handlers=[{
        "url": "http://tempurl.org/webhook",
        "secret": "some-secret",
        "proxy": "proxy-key",
        "custom_http_headers": {
            "header-1": "value-1",
            "header-2": "value-2",
        },
    }],
    opts = pulumi.ResourceOptions(depends_on=[my_docker_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_docker_local, err := artifactory.NewDockerV2Repository(ctx, "my-docker-local", &artifactory.DockerV2RepositoryArgs{
			Key: pulumi.String("my-docker-local"),
		})
		if err != nil {
			return err
		}
		_, err = artifactory.NewDockerWebhook(ctx, "docker-webhook", &artifactory.DockerWebhookArgs{
			Key: pulumi.String("docker-webhook"),
			EventTypes: pulumi.StringArray{
				pulumi.String("pushed"),
				pulumi.String("deleted"),
				pulumi.String("promoted"),
			},
			Criteria: &artifactory.DockerWebhookCriteriaArgs{
				AnyLocal:     pulumi.Bool(true),
				AnyRemote:    pulumi.Bool(false),
				AnyFederated: pulumi.Bool(false),
				RepoKeys: pulumi.StringArray{
					my_docker_local.Key,
				},
				IncludePatterns: pulumi.StringArray{
					pulumi.String("foo/**"),
				},
				ExcludePatterns: pulumi.StringArray{
					pulumi.String("bar/**"),
				},
			},
			Handlers: artifactory.DockerWebhookHandlerArray{
				&artifactory.DockerWebhookHandlerArgs{
					Url:    pulumi.String("http://tempurl.org/webhook"),
					Secret: pulumi.String("some-secret"),
					Proxy:  pulumi.String("proxy-key"),
					CustomHttpHeaders: pulumi.StringMap{
						"header-1": pulumi.String("value-1"),
						"header-2": pulumi.String("value-2"),
					},
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			my_docker_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_docker_local = new Artifactory.DockerV2Repository("my-docker-local", new()
    {
        Key = "my-docker-local",
    });

    var docker_webhook = new Artifactory.DockerWebhook("docker-webhook", new()
    {
        Key = "docker-webhook",
        EventTypes = new[]
        {
            "pushed",
            "deleted",
            "promoted",
        },
        Criteria = new Artifactory.Inputs.DockerWebhookCriteriaArgs
        {
            AnyLocal = true,
            AnyRemote = false,
            AnyFederated = false,
            RepoKeys = new[]
            {
                my_docker_local.Key,
            },
            IncludePatterns = new[]
            {
                "foo/**",
            },
            ExcludePatterns = new[]
            {
                "bar/**",
            },
        },
        Handlers = new[]
        {
            new Artifactory.Inputs.DockerWebhookHandlerArgs
            {
                Url = "http://tempurl.org/webhook",
                Secret = "some-secret",
                Proxy = "proxy-key",
                CustomHttpHeaders = 
                {
                    { "header-1", "value-1" },
                    { "header-2", "value-2" },
                },
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            my_docker_local,
        },
    });

});
Copy
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.DockerWebhook;
import com.pulumi.artifactory.DockerWebhookArgs;
import com.pulumi.artifactory.inputs.DockerWebhookCriteriaArgs;
import com.pulumi.artifactory.inputs.DockerWebhookHandlerArgs;
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_webhook = new DockerWebhook("docker-webhook", DockerWebhookArgs.builder()
            .key("docker-webhook")
            .eventTypes(            
                "pushed",
                "deleted",
                "promoted")
            .criteria(DockerWebhookCriteriaArgs.builder()
                .anyLocal(true)
                .anyRemote(false)
                .anyFederated(false)
                .repoKeys(my_docker_local.key())
                .includePatterns("foo/**")
                .excludePatterns("bar/**")
                .build())
            .handlers(DockerWebhookHandlerArgs.builder()
                .url("http://tempurl.org/webhook")
                .secret("some-secret")
                .proxy("proxy-key")
                .customHttpHeaders(Map.ofEntries(
                    Map.entry("header-1", "value-1"),
                    Map.entry("header-2", "value-2")
                ))
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(my_docker_local)
                .build());

    }
}
Copy
resources:
  my-docker-local:
    type: artifactory:DockerV2Repository
    properties:
      key: my-docker-local
  docker-webhook:
    type: artifactory:DockerWebhook
    properties:
      key: docker-webhook
      eventTypes:
        - pushed
        - deleted
        - promoted
      criteria:
        anyLocal: true
        anyRemote: false
        anyFederated: false
        repoKeys:
          - ${["my-docker-local"].key}
        includePatterns:
          - foo/**
        excludePatterns:
          - bar/**
      handlers:
        - url: http://tempurl.org/webhook
          secret: some-secret
          proxy: proxy-key
          customHttpHeaders:
            header-1: value-1
            header-2: value-2
    options:
      dependsOn:
        - ${["my-docker-local"]}
Copy

Create DockerWebhook Resource

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

Constructor syntax

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

@overload
def DockerWebhook(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  event_types: Optional[Sequence[str]] = None,
                  key: Optional[str] = None,
                  criteria: Optional[DockerWebhookCriteriaArgs] = None,
                  description: Optional[str] = None,
                  enabled: Optional[bool] = None,
                  handlers: Optional[Sequence[DockerWebhookHandlerArgs]] = None)
func NewDockerWebhook(ctx *Context, name string, args DockerWebhookArgs, opts ...ResourceOption) (*DockerWebhook, error)
public DockerWebhook(string name, DockerWebhookArgs args, CustomResourceOptions? opts = null)
public DockerWebhook(String name, DockerWebhookArgs args)
public DockerWebhook(String name, DockerWebhookArgs args, CustomResourceOptions options)
type: artifactory:DockerWebhook
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. DockerWebhookArgs
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. DockerWebhookArgs
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. DockerWebhookArgs
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. DockerWebhookArgs
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. DockerWebhookArgs
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 dockerWebhookResource = new Artifactory.DockerWebhook("dockerWebhookResource", new()
{
    EventTypes = new[]
    {
        "string",
    },
    Key = "string",
    Criteria = new Artifactory.Inputs.DockerWebhookCriteriaArgs
    {
        AnyFederated = false,
        AnyLocal = false,
        AnyRemote = false,
        RepoKeys = new[]
        {
            "string",
        },
        ExcludePatterns = new[]
        {
            "string",
        },
        IncludePatterns = new[]
        {
            "string",
        },
    },
    Description = "string",
    Enabled = false,
    Handlers = new[]
    {
        new Artifactory.Inputs.DockerWebhookHandlerArgs
        {
            Url = "string",
            CustomHttpHeaders = 
            {
                { "string", "string" },
            },
            Proxy = "string",
            Secret = "string",
            UseSecretForSigning = false,
        },
    },
});
Copy
example, err := artifactory.NewDockerWebhook(ctx, "dockerWebhookResource", &artifactory.DockerWebhookArgs{
	EventTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Key: pulumi.String("string"),
	Criteria: &artifactory.DockerWebhookCriteriaArgs{
		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.DockerWebhookHandlerArray{
		&artifactory.DockerWebhookHandlerArgs{
			Url: pulumi.String("string"),
			CustomHttpHeaders: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Proxy:               pulumi.String("string"),
			Secret:              pulumi.String("string"),
			UseSecretForSigning: pulumi.Bool(false),
		},
	},
})
Copy
var dockerWebhookResource = new DockerWebhook("dockerWebhookResource", DockerWebhookArgs.builder()
    .eventTypes("string")
    .key("string")
    .criteria(DockerWebhookCriteriaArgs.builder()
        .anyFederated(false)
        .anyLocal(false)
        .anyRemote(false)
        .repoKeys("string")
        .excludePatterns("string")
        .includePatterns("string")
        .build())
    .description("string")
    .enabled(false)
    .handlers(DockerWebhookHandlerArgs.builder()
        .url("string")
        .customHttpHeaders(Map.of("string", "string"))
        .proxy("string")
        .secret("string")
        .useSecretForSigning(false)
        .build())
    .build());
Copy
docker_webhook_resource = artifactory.DockerWebhook("dockerWebhookResource",
    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",
        "custom_http_headers": {
            "string": "string",
        },
        "proxy": "string",
        "secret": "string",
        "use_secret_for_signing": False,
    }])
Copy
const dockerWebhookResource = new artifactory.DockerWebhook("dockerWebhookResource", {
    eventTypes: ["string"],
    key: "string",
    criteria: {
        anyFederated: false,
        anyLocal: false,
        anyRemote: false,
        repoKeys: ["string"],
        excludePatterns: ["string"],
        includePatterns: ["string"],
    },
    description: "string",
    enabled: false,
    handlers: [{
        url: "string",
        customHttpHeaders: {
            string: "string",
        },
        proxy: "string",
        secret: "string",
        useSecretForSigning: false,
    }],
});
Copy
type: artifactory:DockerWebhook
properties:
    criteria:
        anyFederated: false
        anyLocal: false
        anyRemote: false
        excludePatterns:
            - string
        includePatterns:
            - string
        repoKeys:
            - string
    description: string
    enabled: false
    eventTypes:
        - string
    handlers:
        - customHttpHeaders:
            string: string
          proxy: string
          secret: string
          url: string
          useSecretForSigning: false
    key: string
Copy

DockerWebhook 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 DockerWebhook 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: pushed, deleted, promoted.
Key This property is required. string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
Criteria DockerWebhookCriteria
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<DockerWebhookHandler>
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: pushed, deleted, promoted.
Key This property is required. string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
Criteria DockerWebhookCriteriaArgs
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 []DockerWebhookHandlerArgs
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: pushed, deleted, promoted.
key This property is required. String
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria DockerWebhookCriteria
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<DockerWebhookHandler>
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: pushed, deleted, promoted.
key This property is required. string
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria DockerWebhookCriteria
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 DockerWebhookHandler[]
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: pushed, deleted, promoted.
key This property is required. str
The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
criteria DockerWebhookCriteriaArgs
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[DockerWebhookHandlerArgs]
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: pushed, deleted, promoted.
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 DockerWebhook 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 DockerWebhook Resource

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

DockerWebhookCriteria
, DockerWebhookCriteriaArgs

AnyFederated This property is required. bool
Trigger on any federated repo.
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 repo.
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 repo.
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 repo.
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 repo.
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 repo.
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/**.

DockerWebhookHandler
, DockerWebhookHandlerArgs

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.
CustomHttpHeaders Dictionary<string, string>
Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
Proxy string
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
Secret string
Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
UseSecretForSigning bool
When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
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.
CustomHttpHeaders map[string]string
Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
Proxy string
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
Secret string
Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
UseSecretForSigning bool
When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
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.
customHttpHeaders Map<String,String>
Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
proxy String
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
secret String
Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
useSecretForSigning Boolean
When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
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.
customHttpHeaders {[key: string]: string}
Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
proxy string
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
secret string
Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
useSecretForSigning boolean
When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
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.
custom_http_headers Mapping[str, str]
Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
proxy str
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
secret str
Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
use_secret_for_signing bool
When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
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.
customHttpHeaders Map<String>
Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
proxy String
Proxy key from Artifactory UI (Administration > Proxies > Configuration).
secret String
Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
useSecretForSigning Boolean
When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.

Package Details

Repository
artifactory pulumi/pulumi-artifactory
License
Apache-2.0
Notes
This Pulumi package is based on the artifactory Terraform Provider.