Webhook class

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.

Constructors

Webhook(String name, {WebhookArgs? args, CustomResourceOptions? options})

Creates a new Webhook. name The Pulumi resource name. args Arguments used to configure this Webhook. The set of arguments for Webhook. options Resource options controlling this resource's behavior.

Properties

active ↔ Output<bool>

Whether the webhook is active and will receive deliveries.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

displayName ↔ Output<String>

The human-readable display name shown in the UI.

late, final

envName ↔ Output<String?>

The environment name. Set when the webhook is scoped to a specific environment.

late, final

filters ↔ Output<List<String>?>

Specific event types this webhook subscribes to. If empty, all events are delivered.

late, final

format ↔ Output<String?>

The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').

late, final

groups ↔ Output<List<String>?>

Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').

late, final

hashCode → int

The hash code for this object.

no setter, inherited

hasSecret ↔ Output<bool>

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.

late, final

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String?>

The unique identifier name for the webhook within its scope. Optional on creation; if omitted, the service generates a short random name. Always populated in responses.

late, final

organizationName ↔ Output<String>

The organization that owns this webhook.

late, final

payloadUrl ↔ Output<String>

The URL to which webhook payloads are delivered.

late, final

projectName ↔ Output<String?>

The project name. Set when the webhook is scoped to a specific stack.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secret ↔ Output<String?>

Secret will be omitted when returned from the service.

late, final

secretCiphertext ↔ Output<String>

SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP

late, final

stackName ↔ Output<String?>

The stack name. Set when the webhook is scoped to a specific stack.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited