Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. UserWebhook
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-artifactory

artifactory.UserWebhook

Explore with Pulumi AI

artifactory logo
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-artifactory

    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 user_webhook = new artifactory.UserWebhook("user-webhook", {
    key: "user-webhook",
    eventTypes: ["locked"],
    handlers: [{
        url: "http://tempurl.org/webhook",
        secret: "some-secret",
        proxy: "proxy-key",
        customHttpHeaders: {
            "header-1": "value-1",
            "header-2": "value-2",
        },
    }],
});

    import pulumi
import pulumi_artifactory as artifactory

user_webhook = artifactory.UserWebhook("user-webhook",
    key="user-webhook",
    event_types=["locked"],
    handlers=[{
        "url": "http://tempurl.org/webhook",
        "secret": "some-secret",
        "proxy": "proxy-key",
        "custom_http_headers": {
            "header-1": "value-1",
            "header-2": "value-2",
        },
    }])

    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 {
		_, err := artifactory.NewUserWebhook(ctx, "user-webhook", &artifactory.UserWebhookArgs{
			Key: pulumi.String("user-webhook"),
			EventTypes: pulumi.StringArray{
				pulumi.String("locked"),
			},
			Handlers: artifactory.UserWebhookHandlerArray{
				&artifactory.UserWebhookHandlerArgs{
					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"),
					},
				},
			},
		})
		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 user_webhook = new Artifactory.UserWebhook("user-webhook", new()
    {
        Key = "user-webhook",
        EventTypes = new[]
        {
            "locked",
        },
        Handlers = new[]
        {
            new Artifactory.Inputs.UserWebhookHandlerArgs
            {
                Url = "http://tempurl.org/webhook",
                Secret = "some-secret",
                Proxy = "proxy-key",
                CustomHttpHeaders = 
                {
                    { "header-1", "value-1" },
                    { "header-2", "value-2" },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.UserWebhook;
import com.pulumi.artifactory.UserWebhookArgs;
import com.pulumi.artifactory.inputs.UserWebhookHandlerArgs;
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 user_webhook = new UserWebhook("user-webhook", UserWebhookArgs.builder()
            .key("user-webhook")
            .eventTypes("locked")
            .handlers(UserWebhookHandlerArgs.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());

    }
}

    resources:
  user-webhook:
    type: artifactory:UserWebhook
    properties:
      key: user-webhook
      eventTypes:
        - locked
      handlers:
        - url: http://tempurl.org/webhook
          secret: some-secret
          proxy: proxy-key
          customHttpHeaders:
            header-1: value-1
            header-2: value-2

    Create UserWebhook Resource

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

    Constructor syntax

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

@overload
def UserWebhook(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                event_types: Optional[Sequence[str]] = None,
                key: Optional[str] = None,
                description: Optional[str] = None,
                enabled: Optional[bool] = None,
                handlers: Optional[Sequence[UserWebhookHandlerArgs]] = None)
    func NewUserWebhook(ctx *Context, name string, args UserWebhookArgs, opts ...ResourceOption) (*UserWebhook, error)
    public UserWebhook(string name, UserWebhookArgs args, CustomResourceOptions? opts = null)
    public UserWebhook(String name, UserWebhookArgs args)
public UserWebhook(String name, UserWebhookArgs args, CustomResourceOptions options)

    type: artifactory:UserWebhook
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 UserWebhookArgs
    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 UserWebhookArgs
    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 UserWebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserWebhookArgs
    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 userWebhookResource = new Artifactory.UserWebhook("userWebhookResource", new()
{
    EventTypes = new[]
    {
        "string",
    },
    Key = "string",
    Description = "string",
    Enabled = false,
    Handlers = new[]
    {
        new Artifactory.Inputs.UserWebhookHandlerArgs
        {
            Url = "string",
            CustomHttpHeaders = 
            {
                { "string", "string" },
            },
            Proxy = "string",
            Secret = "string",
            UseSecretForSigning = false,
        },
    },
});

    example, err := artifactory.NewUserWebhook(ctx, "userWebhookResource", &artifactory.UserWebhookArgs{
	EventTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Key:         pulumi.String("string"),
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Handlers: artifactory.UserWebhookHandlerArray{
		&artifactory.UserWebhookHandlerArgs{
			Url: pulumi.String("string"),
			CustomHttpHeaders: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Proxy:               pulumi.String("string"),
			Secret:              pulumi.String("string"),
			UseSecretForSigning: pulumi.Bool(false),
		},
	},
})

    var userWebhookResource = new UserWebhook("userWebhookResource", UserWebhookArgs.builder()
    .eventTypes("string")
    .key("string")
    .description("string")
    .enabled(false)
    .handlers(UserWebhookHandlerArgs.builder()
        .url("string")
        .customHttpHeaders(Map.of("string", "string"))
        .proxy("string")
        .secret("string")
        .useSecretForSigning(false)
        .build())
    .build());

    user_webhook_resource = artifactory.UserWebhook("userWebhookResource",
    event_types=["string"],
    key="string",
    description="string",
    enabled=False,
    handlers=[{
        "url": "string",
        "custom_http_headers": {
            "string": "string",
        },
        "proxy": "string",
        "secret": "string",
        "use_secret_for_signing": False,
    }])

    const userWebhookResource = new artifactory.UserWebhook("userWebhookResource", {
    eventTypes: ["string"],
    key: "string",
    description: "string",
    enabled: false,
    handlers: [{
        url: "string",
        customHttpHeaders: {
            string: "string",
        },
        proxy: "string",
        secret: "string",
        useSecretForSigning: false,
    }],
});

    type: artifactory:UserWebhook
properties:
    description: string
    enabled: false
    eventTypes:
        - string
    handlers:
        - customHttpHeaders:
            string: string
          proxy: string
          secret: string
          url: string
          useSecretForSigning: false
    key: string

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

    EventTypes List<string>
    List of event triggers for the Webhook. Allow values: locked
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true
    Handlers List<UserWebhookHandler>
    At least one is required.
    EventTypes []string
    List of event triggers for the Webhook. Allow values: locked
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true
    Handlers []UserWebhookHandlerArgs
    At least one is required.
    eventTypes List<String>
    List of event triggers for the Webhook. Allow values: locked
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true
    handlers List<UserWebhookHandler>
    At least one is required.
    eventTypes string[]
    List of event triggers for the Webhook. Allow values: locked
    key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description string
    Webhook description. Max length 1000 characters.
    enabled boolean
    Status of webhook. Default to true
    handlers UserWebhookHandler[]
    At least one is required.
    event_types Sequence[str]
    List of event triggers for the Webhook. Allow values: locked
    key str
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description str
    Webhook description. Max length 1000 characters.
    enabled bool
    Status of webhook. Default to true
    handlers Sequence[UserWebhookHandlerArgs]
    At least one is required.
    eventTypes List<String>
    List of event triggers for the Webhook. Allow values: locked
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    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 UserWebhook 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 UserWebhook Resource

    Get an existing UserWebhook 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?: UserWebhookState, opts?: CustomResourceOptions): UserWebhook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        event_types: Optional[Sequence[str]] = None,
        handlers: Optional[Sequence[UserWebhookHandlerArgs]] = None,
        key: Optional[str] = None) -> UserWebhook
    func GetUserWebhook(ctx *Context, name string, id IDInput, state *UserWebhookState, opts ...ResourceOption) (*UserWebhook, error)
    public static UserWebhook Get(string name, Input<string> id, UserWebhookState? state, CustomResourceOptions? opts = null)
    public static UserWebhook get(String name, Output<String> id, UserWebhookState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true
    EventTypes List<string>
    List of event triggers for the Webhook. Allow values: locked
    Handlers List<UserWebhookHandler>
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true
    EventTypes []string
    List of event triggers for the Webhook. Allow values: locked
    Handlers []UserWebhookHandlerArgs
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true
    eventTypes List<String>
    List of event triggers for the Webhook. Allow values: locked
    handlers List<UserWebhookHandler>
    At least one is required.
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description string
    Webhook description. Max length 1000 characters.
    enabled boolean
    Status of webhook. Default to true
    eventTypes string[]
    List of event triggers for the Webhook. Allow values: locked
    handlers UserWebhookHandler[]
    At least one is required.
    key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description str
    Webhook description. Max length 1000 characters.
    enabled bool
    Status of webhook. Default to true
    event_types Sequence[str]
    List of event triggers for the Webhook. Allow values: locked
    handlers Sequence[UserWebhookHandlerArgs]
    At least one is required.
    key str
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true
    eventTypes List<String>
    List of event triggers for the Webhook. Allow values: locked
    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

    UserWebhookHandler, UserWebhookHandlerArgs

    Url 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 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 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 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 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 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.
    artifactory logo
    artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-artifactory