Grafana v0.7.0, Nov 5 24

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

grafana.OncallOutgoingWebhook

Explore with Pulumi AI

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumiverse/grafana";

const test_acc_outgoingWebhook = new grafana.oncall.OutgoingWebhook("test-acc-outgoing_webhook", {
    name: "my outgoing webhook",
    url: "https://example.com/",
});

import pulumi
import pulumiverse_grafana as grafana

test_acc_outgoing_webhook = grafana.on_call.OutgoingWebhook("test-acc-outgoing_webhook",
    name="my outgoing webhook",
    url="https://example.com/")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := onCall.NewOutgoingWebhook(ctx, "test-acc-outgoing_webhook", &onCall.OutgoingWebhookArgs{
			Name: pulumi.String("my outgoing webhook"),
			Url:  pulumi.String("https://example.com/"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumiverse.Grafana;

return await Deployment.RunAsync(() => 
{
    var test_acc_outgoingWebhook = new Grafana.OnCall.OutgoingWebhook("test-acc-outgoing_webhook", new()
    {
        Name = "my outgoing webhook",
        Url = "https://example.com/",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.onCall.OutgoingWebhook;
import com.pulumi.grafana.onCall.OutgoingWebhookArgs;
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 OutgoingWebhook("test-acc-outgoingWebhook", OutgoingWebhookArgs.builder()
            .name("my outgoing webhook")
            .url("https://example.com/")
            .build());

    }
}

resources:
  test-acc-outgoingWebhook:
    type: grafana:onCall:OutgoingWebhook
    name: test-acc-outgoing_webhook
    properties:
      name: my outgoing webhook
      url: https://example.com/

Create OncallOutgoingWebhook Resource

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

Constructor syntax

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

@overload
def OncallOutgoingWebhook(resource_name: str,
                          args: OncallOutgoingWebhookArgs,
                          opts: Optional[ResourceOptions] = None)

@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,
                          headers: Optional[str] = None,
                          http_method: Optional[str] = None,
                          integration_filters: Optional[Sequence[str]] = None,
                          is_webhook_enabled: Optional[bool] = None,
                          name: Optional[str] = None,
                          password: Optional[str] = None,
                          team_id: Optional[str] = None,
                          trigger_template: Optional[str] = None,
                          trigger_type: Optional[str] = None,
                          url: Optional[str] = None,
                          user: Optional[str] = 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.

Parameters

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
Headers string: Headers to add to the outgoing webhook request.
HttpMethod string: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
IntegrationFilters List<string>: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
IsWebhookEnabled bool: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
TriggerTemplate string: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
TriggerType string: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
User string: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
Headers string: Headers to add to the outgoing webhook request.
HttpMethod string: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
IntegrationFilters []string: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
IsWebhookEnabled bool: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
TriggerTemplate string: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
TriggerType string: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
User string: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
headers String: Headers to add to the outgoing webhook request.
httpMethod String: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
integrationFilters List<String>: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
isWebhookEnabled Boolean: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
triggerTemplate String: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
triggerType String: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
user String: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
headers string: Headers to add to the outgoing webhook request.
httpMethod string: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
integrationFilters string[]: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
isWebhookEnabled boolean: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
triggerTemplate string: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
triggerType string: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
user string: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
headers str: Headers to add to the outgoing webhook request.
http_method str: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
integration_filters Sequence[str]: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
is_webhook_enabled bool: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
trigger_template str: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
trigger_type str: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
user str: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
headers String: Headers to add to the outgoing webhook request.
httpMethod String: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
integrationFilters List<String>: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
isWebhookEnabled Boolean: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
triggerTemplate String: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
triggerType String: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
user String: Username to use when making the outgoing webhook request.

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,
        headers: Optional[str] = None,
        http_method: Optional[str] = None,
        integration_filters: Optional[Sequence[str]] = None,
        is_webhook_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        team_id: Optional[str] = None,
        trigger_template: Optional[str] = None,
        trigger_type: 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: Toggle to send the entire webhook payload instead of using the values in the Data field.
Headers string: Headers to add to the outgoing webhook request.
HttpMethod string: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
IntegrationFilters List<string>: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
IsWebhookEnabled bool: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
TriggerTemplate string: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
TriggerType string: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
Url string: The webhook URL.
User string: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
Headers string: Headers to add to the outgoing webhook request.
HttpMethod string: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
IntegrationFilters []string: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
IsWebhookEnabled bool: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
TriggerTemplate string: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
TriggerType string: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
Url string: The webhook URL.
User string: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
headers String: Headers to add to the outgoing webhook request.
httpMethod String: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
integrationFilters List<String>: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
isWebhookEnabled Boolean: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
triggerTemplate String: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
triggerType String: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
url String: The webhook URL.
user String: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
headers string: Headers to add to the outgoing webhook request.
httpMethod string: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
integrationFilters string[]: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
isWebhookEnabled boolean: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
triggerTemplate string: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
triggerType string: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
url string: The webhook URL.
user string: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
headers str: Headers to add to the outgoing webhook request.
http_method str: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
integration_filters Sequence[str]: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
is_webhook_enabled bool: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
trigger_template str: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
trigger_type str: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
url str: The webhook URL.
user str: Username to use when making the outgoing webhook request.

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: Toggle to send the entire webhook payload instead of using the values in the Data field.
headers String: Headers to add to the outgoing webhook request.
httpMethod String: The HTTP method used in the request made by the outgoing webhook. Defaults to POST.
integrationFilters List<String>: Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
isWebhookEnabled Boolean: Controls whether the outgoing webhook will trigger or is ignored. Defaults to true.
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.onCall.getTeam datasource.
triggerTemplate String: A template used to dynamically determine whether the webhook should execute based on the content of the payload.
triggerType String: The type of event that will cause this outgoing webhook to execute. The types of triggers are: escalation, alert group created, acknowledge, resolve, silence, unsilence, unresolve, unacknowledge. Defaults to escalation.
url String: The webhook URL.
user String: Username to use when making the outgoing webhook request.

Import

$ pulumi import grafana:index/oncallOutgoingWebhook:OncallOutgoingWebhook name "{{ id }}"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

pulumiverse/pulumi-grafana

grafana.OncallOutgoingWebhook

On this page

On this page

Example Usage

Create OncallOutgoingWebhook Resource

Constructor syntax

Parameters

OncallOutgoingWebhook Resource Properties

Inputs

Outputs

Look up Existing OncallOutgoingWebhook Resource

Import

Package Details

On this page

On this page