Grafana v0.0.10, May 21 23

grafana.OncallOutgoingWebhook

Explore with Pulumi AI

HTTP API

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Lbrlabs.PulumiPackage.Grafana;

return await Deployment.RunAsync(() => 
{
    var test_acc_outgoingWebhook = new Grafana.OncallOutgoingWebhook("test-acc-outgoingWebhook", new()
    {
        Url = "https://example.com/",
    }, new CustomResourceOptions
    {
        Provider = grafana.Oncall,
    });

});

package main

import (
	"github.com/lbrlabs/pulumi-grafana/sdk/go/grafana"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := grafana.NewOncallOutgoingWebhook(ctx, "test-acc-outgoingWebhook", &grafana.OncallOutgoingWebhookArgs{
			Url: pulumi.String("https://example.com/"),
		}, pulumi.Provider(grafana.Oncall))
		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.grafana.OncallOutgoingWebhook;
import com.pulumi.grafana.OncallOutgoingWebhookArgs;
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 test_acc_outgoingWebhook = new OncallOutgoingWebhook("test-acc-outgoingWebhook", OncallOutgoingWebhookArgs.builder()        
            .url("https://example.com/")
            .build(), CustomResourceOptions.builder()
                .provider(grafana.oncall())
                .build());

    }
}

import pulumi
import lbrlabs_pulumi_grafana as grafana

test_acc_outgoing_webhook = grafana.OncallOutgoingWebhook("test-acc-outgoingWebhook", url="https://example.com/",
opts=pulumi.ResourceOptions(provider=grafana["oncall"]))

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@lbrlabs/pulumi-grafana";

const test_acc_outgoingWebhook = new grafana.OncallOutgoingWebhook("test-acc-outgoingWebhook", {url: "https://example.com/"}, {
    provider: grafana.oncall,
});

resources:
  test-acc-outgoingWebhook:
    type: grafana:OncallOutgoingWebhook
    properties:
      url: https://example.com/
    options:
      provider: ${grafana.oncall}

Create OncallOutgoingWebhook Resource

new OncallOutgoingWebhook(name: string, args: OncallOutgoingWebhookArgs, opts?: CustomResourceOptions);

@overload
def OncallOutgoingWebhook(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          authorization_header: Optional[str] = None,
                          data: Optional[str] = None,
                          forward_whole_payload: Optional[bool] = None,
                          name: Optional[str] = None,
                          password: Optional[str] = None,
                          team_id: Optional[str] = None,
                          url: Optional[str] = None,
                          user: Optional[str] = None)
@overload
def OncallOutgoingWebhook(resource_name: str,
                          args: OncallOutgoingWebhookArgs,
                          opts: Optional[ResourceOptions] = None)

func NewOncallOutgoingWebhook(ctx *Context, name string, args OncallOutgoingWebhookArgs, opts ...ResourceOption) (*OncallOutgoingWebhook, error)

public OncallOutgoingWebhook(string name, OncallOutgoingWebhookArgs args, CustomResourceOptions? opts = null)

public OncallOutgoingWebhook(String name, OncallOutgoingWebhookArgs args)
public OncallOutgoingWebhook(String name, OncallOutgoingWebhookArgs args, CustomResourceOptions options)

type: grafana:OncallOutgoingWebhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

name string: The unique name of the resource.
args OncallOutgoingWebhookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OncallOutgoingWebhookArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Url string: The webhook URL.
AuthorizationHeader string: The auth data of the webhook. Used in Authorization header instead of user/password auth.
Data string: The data of the webhook.
ForwardWholePayload bool: Forwards whole payload of the alert to the webhook's url as POST data.
Name string: The name of the outgoing webhook.
Password string: The auth data of the webhook. Used for Basic authentication
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
User string: The auth data of the webhook. Used for Basic authentication.

Url string: The webhook URL.
AuthorizationHeader string: The auth data of the webhook. Used in Authorization header instead of user/password auth.
Data string: The data of the webhook.
ForwardWholePayload bool: Forwards whole payload of the alert to the webhook's url as POST data.
Name string: The name of the outgoing webhook.
Password string: The auth data of the webhook. Used for Basic authentication
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
User string: The auth data of the webhook. Used for Basic authentication.

url String: The webhook URL.
authorizationHeader String: The auth data of the webhook. Used in Authorization header instead of user/password auth.
data String: The data of the webhook.
forwardWholePayload Boolean: Forwards whole payload of the alert to the webhook's url as POST data.
name String: The name of the outgoing webhook.
password String: The auth data of the webhook. Used for Basic authentication
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
user String: The auth data of the webhook. Used for Basic authentication.

url string: The webhook URL.
authorizationHeader string: The auth data of the webhook. Used in Authorization header instead of user/password auth.
data string: The data of the webhook.
forwardWholePayload boolean: Forwards whole payload of the alert to the webhook's url as POST data.
name string: The name of the outgoing webhook.
password string: The auth data of the webhook. Used for Basic authentication
teamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
user string: The auth data of the webhook. Used for Basic authentication.

url str: The webhook URL.
authorization_header str: The auth data of the webhook. Used in Authorization header instead of user/password auth.
data str: The data of the webhook.
forward_whole_payload bool: Forwards whole payload of the alert to the webhook's url as POST data.
name str: The name of the outgoing webhook.
password str: The auth data of the webhook. Used for Basic authentication
team_id str: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
user str: The auth data of the webhook. Used for Basic authentication.

url String: The webhook URL.
authorizationHeader String: The auth data of the webhook. Used in Authorization header instead of user/password auth.
data String: The data of the webhook.
forwardWholePayload Boolean: Forwards whole payload of the alert to the webhook's url as POST data.
name String: The name of the outgoing webhook.
password String: The auth data of the webhook. Used for Basic authentication
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
user String: The auth data of the webhook. Used for Basic authentication.

Outputs

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

Get an existing OncallOutgoingWebhook 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?: OncallOutgoingWebhookState, opts?: CustomResourceOptions): OncallOutgoingWebhook

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization_header: Optional[str] = None,
        data: Optional[str] = None,
        forward_whole_payload: Optional[bool] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        team_id: Optional[str] = None,
        url: Optional[str] = None,
        user: Optional[str] = None) -> OncallOutgoingWebhook

func GetOncallOutgoingWebhook(ctx *Context, name string, id IDInput, state *OncallOutgoingWebhookState, opts ...ResourceOption) (*OncallOutgoingWebhook, error)

public static OncallOutgoingWebhook Get(string name, Input<string> id, OncallOutgoingWebhookState? state, CustomResourceOptions? opts = null)

public static OncallOutgoingWebhook get(String name, Output<String> id, OncallOutgoingWebhookState 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:

AuthorizationHeader string: The auth data of the webhook. Used in Authorization header instead of user/password auth.
Data string: The data of the webhook.
ForwardWholePayload bool: Forwards whole payload of the alert to the webhook's url as POST data.
Name string: The name of the outgoing webhook.
Password string: The auth data of the webhook. Used for Basic authentication
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
Url string: The webhook URL.
User string: The auth data of the webhook. Used for Basic authentication.

AuthorizationHeader string: The auth data of the webhook. Used in Authorization header instead of user/password auth.
Data string: The data of the webhook.
ForwardWholePayload bool: Forwards whole payload of the alert to the webhook's url as POST data.
Name string: The name of the outgoing webhook.
Password string: The auth data of the webhook. Used for Basic authentication
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
Url string: The webhook URL.
User string: The auth data of the webhook. Used for Basic authentication.

authorizationHeader String: The auth data of the webhook. Used in Authorization header instead of user/password auth.
data String: The data of the webhook.
forwardWholePayload Boolean: Forwards whole payload of the alert to the webhook's url as POST data.
name String: The name of the outgoing webhook.
password String: The auth data of the webhook. Used for Basic authentication
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
url String: The webhook URL.
user String: The auth data of the webhook. Used for Basic authentication.

authorizationHeader string: The auth data of the webhook. Used in Authorization header instead of user/password auth.
data string: The data of the webhook.
forwardWholePayload boolean: Forwards whole payload of the alert to the webhook's url as POST data.
name string: The name of the outgoing webhook.
password string: The auth data of the webhook. Used for Basic authentication
teamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
url string: The webhook URL.
user string: The auth data of the webhook. Used for Basic authentication.

authorization_header str: The auth data of the webhook. Used in Authorization header instead of user/password auth.
data str: The data of the webhook.
forward_whole_payload bool: Forwards whole payload of the alert to the webhook's url as POST data.
name str: The name of the outgoing webhook.
password str: The auth data of the webhook. Used for Basic authentication
team_id str: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
url str: The webhook URL.
user str: The auth data of the webhook. Used for Basic authentication.

authorizationHeader String: The auth data of the webhook. Used in Authorization header instead of user/password auth.
data String: The data of the webhook.
forwardWholePayload Boolean: Forwards whole payload of the alert to the webhook's url as POST data.
name String: The name of the outgoing webhook.
password String: The auth data of the webhook. Used for Basic authentication
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
url String: The webhook URL.
user String: The auth data of the webhook. Used for Basic authentication.

Import

 $ pulumi import grafana:index/oncallOutgoingWebhook:OncallOutgoingWebhook outgoing_webhook_name {{outgoing_webhook_id}}

Package Details

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