Webhook class

Pulumi Webhooks allow you to notify external services of events happening within your Pulumi organization or stack. For example, you can trigger a notification whenever a stack is updated. Whenever an event occurs, Pulumi will send an HTTP POST request to all registered webhooks. The webhook can then be used to emit some notification, start running integration tests, or even update additional stacks.

Import

Pulumi webhooks can be imported using the id, which for webhooks is {org}/{project}/{stack}/{webhook-name} e.g.,

 $ pulumi import pulumiservice:index:Webhook my_webhook my-org/my-project/my-stack/4b0d0671

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>

Indicates whether this webhook is enabled or not.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

displayName ↔ Output<String>

The friendly name displayed in the Pulumi Cloud.

late, final

environmentName ↔ Output<String?>

Name of the environment. Only specified if this is an environment webhook.

late, final

filters ↔ Output<List<WebhookFilters>?>

Optional set of filters to apply to the webhook. See webhook docs for more information.

late, final

format ↔ Output<WebhookFormat>

Format of the webhook payload. Can be either raw, slack, ms_teams or pulumi_deployments. Defaults to raw.

late, final

groups ↔ Output<List<WebhookGroup>?>

Optional set of filter groups to apply to the webhook. See webhook docs for more information.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

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>

Webhook identifier generated by Pulumi Cloud.

late, final

organizationName ↔ Output<String>

Name of the organization.

late, final

payloadUrl ↔ Output<String>

URL to send request to.

late, final

projectName ↔ Output<String?>

Name of the project. Only specified if this is a stack or environment webhook.

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?>

Optional. secret used as the HMAC key. See webhook docs for more information.

late, final

stackName ↔ Output<String?>

Name of the stack. Only needed if this is a stack webhook.

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