pulumi-better-uptime/bin/outgoingWebhook.d.ts

A Pulumi provider for managing Better Uptime monitoring, alerting, and incident management resources, dynamically bridged from the Terraform Better Uptime provider with support for monitors, heartbeats, integrations, status pages, and policies.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class OutgoingWebhook extends pulumi.CustomResource {
    /**
     * Get an existing OutgoingWebhook resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OutgoingWebhookState, opts?: pulumi.CustomResourceOptions): OutgoingWebhook;
    /**
     * Returns true if the given object is an instance of OutgoingWebhook.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is OutgoingWebhook;
    /**
     * Custom webhook template configuration.
     */
    readonly customWebhookTemplateAttributes: pulumi.Output<outputs.OutgoingWebhookCustomWebhookTemplateAttributes | undefined>;
    /**
     * The name of the outgoing webhook.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Whether to trigger webhook when incident is acknowledged. Only when `trigger_type=incident_change`.
     */
    readonly onIncidentAcknowledged: pulumi.Output<boolean | undefined>;
    /**
     * Whether to trigger webhook when incident is resolved. Only when `trigger_type=incident_change`.
     */
    readonly onIncidentResolved: pulumi.Output<boolean | undefined>;
    /**
     * Whether to trigger webhook when incident starts. Only when `trigger_type=incident_change`.
     */
    readonly onIncidentStarted: pulumi.Output<boolean | undefined>;
    /**
     * Used to specify the team the resource should be created in when using global tokens.
     */
    readonly teamName: pulumi.Output<string | undefined>;
    /**
     * The type of trigger for the webhook. Only settable during creation. Available values: `incident_change`,
     * `on_call_change`, `monitor_change`.
     */
    readonly triggerType: pulumi.Output<string>;
    /**
     * The URL to send webhooks to.
     */
    readonly url: pulumi.Output<string>;
    /**
     * Create a OutgoingWebhook resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: OutgoingWebhookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OutgoingWebhook resources.
 */
export interface OutgoingWebhookState {
    /**
     * Custom webhook template configuration.
     */
    customWebhookTemplateAttributes?: pulumi.Input<inputs.OutgoingWebhookCustomWebhookTemplateAttributes>;
    /**
     * The name of the outgoing webhook.
     */
    name?: pulumi.Input<string>;
    /**
     * Whether to trigger webhook when incident is acknowledged. Only when `trigger_type=incident_change`.
     */
    onIncidentAcknowledged?: pulumi.Input<boolean>;
    /**
     * Whether to trigger webhook when incident is resolved. Only when `trigger_type=incident_change`.
     */
    onIncidentResolved?: pulumi.Input<boolean>;
    /**
     * Whether to trigger webhook when incident starts. Only when `trigger_type=incident_change`.
     */
    onIncidentStarted?: pulumi.Input<boolean>;
    /**
     * Used to specify the team the resource should be created in when using global tokens.
     */
    teamName?: pulumi.Input<string>;
    /**
     * The type of trigger for the webhook. Only settable during creation. Available values: `incident_change`,
     * `on_call_change`, `monitor_change`.
     */
    triggerType?: pulumi.Input<string>;
    /**
     * The URL to send webhooks to.
     */
    url?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a OutgoingWebhook resource.
 */
export interface OutgoingWebhookArgs {
    /**
     * Custom webhook template configuration.
     */
    customWebhookTemplateAttributes?: pulumi.Input<inputs.OutgoingWebhookCustomWebhookTemplateAttributes>;
    /**
     * The name of the outgoing webhook.
     */
    name?: pulumi.Input<string>;
    /**
     * Whether to trigger webhook when incident is acknowledged. Only when `trigger_type=incident_change`.
     */
    onIncidentAcknowledged?: pulumi.Input<boolean>;
    /**
     * Whether to trigger webhook when incident is resolved. Only when `trigger_type=incident_change`.
     */
    onIncidentResolved?: pulumi.Input<boolean>;
    /**
     * Whether to trigger webhook when incident starts. Only when `trigger_type=incident_change`.
     */
    onIncidentStarted?: pulumi.Input<boolean>;
    /**
     * Used to specify the team the resource should be created in when using global tokens.
     */
    teamName?: pulumi.Input<string>;
    /**
     * The type of trigger for the webhook. Only settable during creation. Available values: `incident_change`,
     * `on_call_change`, `monitor_change`.
     */
    triggerType: pulumi.Input<string>;
    /**
     * The URL to send webhooks to.
     */
    url: pulumi.Input<string>;
}