WebhookApiStacks class

Creates a new webhook for the specified stack. The request body must include the webhook name, payload URL, and format.

The format field accepts: raw (default), slack, ms_teams, or pulumi_deployments.

The filters field accepts a list of event types to subscribe to. See the webhook event filtering documentation for available filters.

The optional secret field sets the HMAC key for signature verification. See the webhook headers documentation for details.

Returns 409 if a webhook with the same name already exists. Returns 400 if the organization or stack name in the request body does not match the URL path parameters.

Constructors

WebhookApiStacks(String name, {WebhookApiStacksArgs? args, CustomResourceOptions? options})
Creates a new WebhookApiStacks. name The Pulumi resource name. args Arguments used to configure this WebhookApiStacks. 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.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
displayName ↔ Output<String>
The human-readable display name shown in the UI.
latefinal
envName ↔ Output<String?>
The environment name. Set when the webhook is scoped to a specific environment.
latefinal
filters ↔ Output<List<String>?>
Specific event types this webhook subscribes to. If empty, all events are delivered.
latefinal
format ↔ Output<String?>
The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
latefinal
groups ↔ Output<List<String>?>
Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
latefinal
hashCode → int
The hash code for this object.
no setterinherited
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.
latefinal
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
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.
latefinal
organizationName ↔ Output<String>
The organization that owns this webhook.
latefinal
payloadUrl ↔ Output<String>
The URL to which webhook payloads are delivered.
latefinal
projectName ↔ Output<String?>
The project name. Set when the webhook is scoped to a specific stack.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secret ↔ Output<String?>
Secret will be omitted when returned from the service.
latefinal
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
latefinal
stackName ↔ Output<String?>
The stack name. Set when the webhook is scoped to a specific stack.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

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