@pulumi/pulumiservice
Version:
[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io
140 lines • 5.48 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a new webhook for a Pulumi ESC environment. Webhooks allow external services to be notified when environment events occur, such as updates or opens. The request body specifies the webhook configuration including the destination URL, event filters, and format. Returns 400 if the organization name in the request body does not match the URL path parameter. Returns 409 if a webhook with the same name already exists.
*/
export declare class Webhook extends pulumi.CustomResource {
/**
* Get an existing Webhook 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Webhook;
/**
* Returns true if the given object is an instance of Webhook. 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 Webhook;
/**
* Whether the webhook is active and will receive deliveries.
*/
readonly active: pulumi.Output<boolean>;
/**
* The human-readable display name shown in the UI.
*/
readonly displayName: pulumi.Output<string>;
/**
* The environment name. Set when the webhook is scoped to a specific environment.
*/
readonly envName: pulumi.Output<string | undefined>;
/**
* Specific event types this webhook subscribes to. If empty, all events are delivered.
*/
readonly filters: pulumi.Output<string[] | undefined>;
/**
* The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
*/
readonly format: pulumi.Output<string | undefined>;
/**
* Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
*/
readonly groups: pulumi.Output<string[] | undefined>;
/**
* HasSecret is true if the webhook has a secret. This is used to determine whether
* to show that there is a secret in the UI.
*/
readonly hasSecret: pulumi.Output<boolean>;
/**
* The unique identifier name for the webhook within its scope.
*/
readonly name: pulumi.Output<string>;
/**
* The organization that owns this webhook.
*/
readonly organizationName: pulumi.Output<string>;
/**
* The URL to which webhook payloads are delivered.
*/
readonly payloadUrl: pulumi.Output<string>;
/**
* The project name. Set when the webhook is scoped to a specific stack.
*/
readonly projectName: pulumi.Output<string | undefined>;
/**
* Secret will be omitted when returned from the service.
*/
readonly secret: pulumi.Output<string | undefined>;
/**
* SecretCiphertext is the ciphertext value of the webhook's secret.
* It's used to check whether the secret was changed by the PSP
*/
readonly secretCiphertext: pulumi.Output<string>;
/**
* The stack name. Set when the webhook is scoped to a specific stack.
*/
readonly stackName: pulumi.Output<string | undefined>;
/**
* Create a Webhook 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: WebhookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Webhook resource.
*/
export interface WebhookArgs {
/**
* Whether the webhook is active and will receive deliveries.
*/
active: pulumi.Input<boolean>;
/**
* The human-readable display name shown in the UI.
*/
displayName: pulumi.Input<string>;
/**
* The environment name. Set when the webhook is scoped to a specific environment.
*/
envName: pulumi.Input<string>;
/**
* Specific event types this webhook subscribes to. If empty, all events are delivered.
*/
filters?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
*/
format?: pulumi.Input<string | undefined>;
/**
* Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
*/
groups?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The unique identifier name for the webhook within its scope.
*/
name: pulumi.Input<string>;
/**
* The organization that owns this webhook.
*/
organizationName: pulumi.Input<string>;
/**
* The URL to which webhook payloads are delivered.
*/
payloadUrl: pulumi.Input<string>;
/**
* The project name. Set when the webhook is scoped to a specific stack.
*/
projectName: pulumi.Input<string>;
/**
* Secret will be omitted when returned from the service.
*/
secret?: pulumi.Input<string | undefined>;
/**
* The stack name. Set when the webhook is scoped to a specific stack.
*/
stackName?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=webhook.d.ts.map