Docs Packages
  1. Packages
  2. SignalFx
  3. API Docs
  4. WebhookIntegration
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.WebhookIntegration

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi
pulumi/pulumi-signalfx

    Splunk Observability Cloud webhook integration.

    NOTE When managing integrations, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See Operations that require a session token for an administrator. Otherwise you’ll receive a 4xx error.

    Example

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

const webhookMyteam = new signalfx.WebhookIntegration("webhookMyteam", {
    enabled: true,
    headers: [{
        headerKey: "some_header",
        headerValue: "value_for_that_header",
    }],
    sharedSecret: "abc1234",
    url: "https://www.example.com",
});

    import pulumi
import pulumi_signalfx as signalfx

webhook_myteam = signalfx.WebhookIntegration("webhookMyteam",
    enabled=True,
    headers=[signalfx.WebhookIntegrationHeaderArgs(
        header_key="some_header",
        header_value="value_for_that_header",
    )],
    shared_secret="abc1234",
    url="https://www.example.com")

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

return await Deployment.RunAsync(() => 
{
    var webhookMyteam = new SignalFx.WebhookIntegration("webhookMyteam", new()
    {
        Enabled = true,
        Headers = new[]
        {
            new SignalFx.Inputs.WebhookIntegrationHeaderArgs
            {
                HeaderKey = "some_header",
                HeaderValue = "value_for_that_header",
            },
        },
        SharedSecret = "abc1234",
        Url = "https://www.example.com",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := signalfx.NewWebhookIntegration(ctx, "webhookMyteam", &signalfx.WebhookIntegrationArgs{
			Enabled: pulumi.Bool(true),
			Headers: signalfx.WebhookIntegrationHeaderArray{
				&signalfx.WebhookIntegrationHeaderArgs{
					HeaderKey:   pulumi.String("some_header"),
					HeaderValue: pulumi.String("value_for_that_header"),
				},
			},
			SharedSecret: pulumi.String("abc1234"),
			Url:          pulumi.String("https://www.example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.WebhookIntegration;
import com.pulumi.signalfx.WebhookIntegrationArgs;
import com.pulumi.signalfx.inputs.WebhookIntegrationHeaderArgs;
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 webhookMyteam = new WebhookIntegration("webhookMyteam", WebhookIntegrationArgs.builder()        
            .enabled(true)
            .headers(WebhookIntegrationHeaderArgs.builder()
                .headerKey("some_header")
                .headerValue("value_for_that_header")
                .build())
            .sharedSecret("abc1234")
            .url("https://www.example.com")
            .build());

    }
}

    resources:
  webhookMyteam:
    type: signalfx:WebhookIntegration
    properties:
      enabled: true
      headers:
        - headerKey: some_header
          headerValue: value_for_that_header
      sharedSecret: abc1234
      url: https://www.example.com

    Arguments

    • name - (Required) Name of the integration.
    • enabled - (Required) Whether the integration is enabled.
    • url - (Required) The URL to request
    • shared_secret - (Optional)
    • headers - (Optional) A header to send with the request
      • header_key - (Required) The key of the header to send
      • header_value - (Required) The value of the header to send

    Attributes

    In a addition to all arguments above, the following attributes are exported:

    • id - The ID of the integration.

    Create WebhookIntegration Resource

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

    Constructor syntax

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

@overload
def WebhookIntegration(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       enabled: Optional[bool] = None,
                       headers: Optional[Sequence[WebhookIntegrationHeaderArgs]] = None,
                       name: Optional[str] = None,
                       shared_secret: Optional[str] = None,
                       url: Optional[str] = None)
    func NewWebhookIntegration(ctx *Context, name string, args WebhookIntegrationArgs, opts ...ResourceOption) (*WebhookIntegration, error)
    public WebhookIntegration(string name, WebhookIntegrationArgs args, CustomResourceOptions? opts = null)
    public WebhookIntegration(String name, WebhookIntegrationArgs args)
public WebhookIntegration(String name, WebhookIntegrationArgs args, CustomResourceOptions options)

    type: signalfx:WebhookIntegration
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 WebhookIntegrationArgs
    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 WebhookIntegrationArgs
    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 WebhookIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebhookIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebhookIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var webhookIntegrationResource = new SignalFx.WebhookIntegration("webhookIntegrationResource", new()
{
    Enabled = false,
    Headers = new[]
    {
        new SignalFx.Inputs.WebhookIntegrationHeaderArgs
        {
            HeaderKey = "string",
            HeaderValue = "string",
        },
    },
    Name = "string",
    SharedSecret = "string",
    Url = "string",
});

    example, err := signalfx.NewWebhookIntegration(ctx, "webhookIntegrationResource", &signalfx.WebhookIntegrationArgs{
	Enabled: pulumi.Bool(false),
	Headers: signalfx.WebhookIntegrationHeaderArray{
		&signalfx.WebhookIntegrationHeaderArgs{
			HeaderKey:   pulumi.String("string"),
			HeaderValue: pulumi.String("string"),
		},
	},
	Name:         pulumi.String("string"),
	SharedSecret: pulumi.String("string"),
	Url:          pulumi.String("string"),
})

    var webhookIntegrationResource = new WebhookIntegration("webhookIntegrationResource", WebhookIntegrationArgs.builder()        
    .enabled(false)
    .headers(WebhookIntegrationHeaderArgs.builder()
        .headerKey("string")
        .headerValue("string")
        .build())
    .name("string")
    .sharedSecret("string")
    .url("string")
    .build());

    webhook_integration_resource = signalfx.WebhookIntegration("webhookIntegrationResource",
    enabled=False,
    headers=[signalfx.WebhookIntegrationHeaderArgs(
        header_key="string",
        header_value="string",
    )],
    name="string",
    shared_secret="string",
    url="string")

    const webhookIntegrationResource = new signalfx.WebhookIntegration("webhookIntegrationResource", {
    enabled: false,
    headers: [{
        headerKey: "string",
        headerValue: "string",
    }],
    name: "string",
    sharedSecret: "string",
    url: "string",
});

    type: signalfx:WebhookIntegration
properties:
    enabled: false
    headers:
        - headerKey: string
          headerValue: string
    name: string
    sharedSecret: string
    url: string

    WebhookIntegration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The WebhookIntegration resource accepts the following input properties:

    Enabled bool
    Whether the integration is enabled or not
    Headers List<Pulumi.SignalFx.Inputs.WebhookIntegrationHeader>
    HTTP headers to pass in the request
    Name string
    Name of the integration
    SharedSecret string
    Url string
    Webhook URL
    Enabled bool
    Whether the integration is enabled or not
    Headers []WebhookIntegrationHeaderArgs
    HTTP headers to pass in the request
    Name string
    Name of the integration
    SharedSecret string
    Url string
    Webhook URL
    enabled Boolean
    Whether the integration is enabled or not
    headers List<WebhookIntegrationHeader>
    HTTP headers to pass in the request
    name String
    Name of the integration
    sharedSecret String
    url String
    Webhook URL
    enabled boolean
    Whether the integration is enabled or not
    headers WebhookIntegrationHeader[]
    HTTP headers to pass in the request
    name string
    Name of the integration
    sharedSecret string
    url string
    Webhook URL
    enabled bool
    Whether the integration is enabled or not
    headers Sequence[WebhookIntegrationHeaderArgs]
    HTTP headers to pass in the request
    name str
    Name of the integration
    shared_secret str
    url str
    Webhook URL
    enabled Boolean
    Whether the integration is enabled or not
    headers List<Property Map>
    HTTP headers to pass in the request
    name String
    Name of the integration
    sharedSecret String
    url String
    Webhook URL

    Outputs

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

    Get an existing WebhookIntegration 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?: WebhookIntegrationState, opts?: CustomResourceOptions): WebhookIntegration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        headers: Optional[Sequence[WebhookIntegrationHeaderArgs]] = None,
        name: Optional[str] = None,
        shared_secret: Optional[str] = None,
        url: Optional[str] = None) -> WebhookIntegration
    func GetWebhookIntegration(ctx *Context, name string, id IDInput, state *WebhookIntegrationState, opts ...ResourceOption) (*WebhookIntegration, error)
    public static WebhookIntegration Get(string name, Input<string> id, WebhookIntegrationState? state, CustomResourceOptions? opts = null)
    public static WebhookIntegration get(String name, Output<String> id, WebhookIntegrationState 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:
    Enabled bool
    Whether the integration is enabled or not
    Headers List<Pulumi.SignalFx.Inputs.WebhookIntegrationHeader>
    HTTP headers to pass in the request
    Name string
    Name of the integration
    SharedSecret string
    Url string
    Webhook URL
    Enabled bool
    Whether the integration is enabled or not
    Headers []WebhookIntegrationHeaderArgs
    HTTP headers to pass in the request
    Name string
    Name of the integration
    SharedSecret string
    Url string
    Webhook URL
    enabled Boolean
    Whether the integration is enabled or not
    headers List<WebhookIntegrationHeader>
    HTTP headers to pass in the request
    name String
    Name of the integration
    sharedSecret String
    url String
    Webhook URL
    enabled boolean
    Whether the integration is enabled or not
    headers WebhookIntegrationHeader[]
    HTTP headers to pass in the request
    name string
    Name of the integration
    sharedSecret string
    url string
    Webhook URL
    enabled bool
    Whether the integration is enabled or not
    headers Sequence[WebhookIntegrationHeaderArgs]
    HTTP headers to pass in the request
    name str
    Name of the integration
    shared_secret str
    url str
    Webhook URL
    enabled Boolean
    Whether the integration is enabled or not
    headers List<Property Map>
    HTTP headers to pass in the request
    name String
    Name of the integration
    sharedSecret String
    url String
    Webhook URL

    Supporting Types

    WebhookIntegrationHeader, WebhookIntegrationHeaderArgs

    HeaderKey string
    HeaderValue string
    HeaderKey string
    HeaderValue string
    headerKey String
    headerValue String
    headerKey string
    headerValue string
    headerKey String
    headerValue String

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi
    pulumi/pulumi-signalfx