Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. OrganizationWebhook

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

pulumiservice.api.OrganizationWebhook

pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

    Creates a new webhook for an organization to notify external services when events occur. Webhooks can be configured to fire on stack events (created, deleted, update succeeded/failed), deployment events (queued, started, succeeded, failed), drift detection events, and policy violation events (mandatory, advisory).

    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 via the Pulumi-Webhook-Signature header. See the webhook headers documentation for details.

    Create OrganizationWebhook Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrganizationWebhook(name: string, args: OrganizationWebhookArgs, opts?: CustomResourceOptions);
    @overload
def OrganizationWebhook(resource_name: str,
                        args: OrganizationWebhookArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def OrganizationWebhook(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        active: Optional[bool] = None,
                        display_name: Optional[str] = None,
                        name: Optional[str] = None,
                        organization_name: Optional[str] = None,
                        payload_url: Optional[str] = None,
                        env_name: Optional[str] = None,
                        filters: Optional[Sequence[str]] = None,
                        format: Optional[str] = None,
                        groups: Optional[Sequence[str]] = None,
                        project_name: Optional[str] = None,
                        secret: Optional[str] = None,
                        stack_name: Optional[str] = None)
    func NewOrganizationWebhook(ctx *Context, name string, args OrganizationWebhookArgs, opts ...ResourceOption) (*OrganizationWebhook, error)
    public OrganizationWebhook(string name, OrganizationWebhookArgs args, CustomResourceOptions? opts = null)
    public OrganizationWebhook(String name, OrganizationWebhookArgs args)
public OrganizationWebhook(String name, OrganizationWebhookArgs args, CustomResourceOptions options)

    type: pulumiservice:api:OrganizationWebhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "pulumiservice_api_organizationwebhook" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args OrganizationWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OrganizationWebhookArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OrganizationWebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationWebhookArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var organizationWebhookResource = new PulumiService.Api.OrganizationWebhook("organizationWebhookResource", new()
{
    Active = false,
    DisplayName = "string",
    Name = "string",
    OrganizationName = "string",
    PayloadUrl = "string",
    EnvName = "string",
    Filters = new[]
    {
        "string",
    },
    Format = "string",
    Groups = new[]
    {
        "string",
    },
    ProjectName = "string",
    Secret = "string",
    StackName = "string",
});

    example, err := api.NewOrganizationWebhook(ctx, "organizationWebhookResource", &api.OrganizationWebhookArgs{
	Active:           pulumi.Bool(false),
	DisplayName:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	OrganizationName: pulumi.String("string"),
	PayloadUrl:       pulumi.String("string"),
	EnvName:          pulumi.String("string"),
	Filters: pulumi.StringArray{
		pulumi.String("string"),
	},
	Format: pulumi.String("string"),
	Groups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProjectName: pulumi.String("string"),
	Secret:      pulumi.String("string"),
	StackName:   pulumi.String("string"),
})

    resource "pulumiservice_api_organizationwebhook" "organizationWebhookResource" {
  active            = false
  display_name      = "string"
  name              = "string"
  organization_name = "string"
  payload_url       = "string"
  env_name          = "string"
  filters           = ["string"]
  format            = "string"
  groups            = ["string"]
  project_name      = "string"
  secret            = "string"
  stack_name        = "string"
}

    var organizationWebhookResource = new OrganizationWebhook("organizationWebhookResource", OrganizationWebhookArgs.builder()
    .active(false)
    .displayName("string")
    .name("string")
    .organizationName("string")
    .payloadUrl("string")
    .envName("string")
    .filters("string")
    .format("string")
    .groups("string")
    .projectName("string")
    .secret("string")
    .stackName("string")
    .build());

    organization_webhook_resource = pulumiservice.api.OrganizationWebhook("organizationWebhookResource",
    active=False,
    display_name="string",
    name="string",
    organization_name="string",
    payload_url="string",
    env_name="string",
    filters=["string"],
    format="string",
    groups=["string"],
    project_name="string",
    secret="string",
    stack_name="string")

    const organizationWebhookResource = new pulumiservice.api.OrganizationWebhook("organizationWebhookResource", {
    active: false,
    displayName: "string",
    name: "string",
    organizationName: "string",
    payloadUrl: "string",
    envName: "string",
    filters: ["string"],
    format: "string",
    groups: ["string"],
    projectName: "string",
    secret: "string",
    stackName: "string",
});

    type: pulumiservice:api:OrganizationWebhook
properties:
    active: false
    displayName: string
    envName: string
    filters:
        - string
    format: string
    groups:
        - string
    name: string
    organizationName: string
    payloadUrl: string
    projectName: string
    secret: string
    stackName: string

    OrganizationWebhook Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OrganizationWebhook resource accepts the following input properties:

    Active bool
    Whether the webhook is active and will receive deliveries.
    DisplayName string
    The human-readable display name shown in the UI.
    Name string
    The unique identifier name for the webhook within its scope.
    OrganizationName string
    The organization that owns this webhook.
    PayloadUrl string
    The URL to which webhook payloads are delivered.
    EnvName string
    The environment name. Set when the webhook is scoped to a specific environment.
    Filters List<string>
    Specific event types this webhook subscribes to. If empty, all events are delivered.
    Format string
    The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
    Groups List<string>
    Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
    ProjectName string
    The project name. Set when the webhook is scoped to a specific stack.
    Secret string
    Secret will be omitted when returned from the service.
    StackName string
    The stack name. Set when the webhook is scoped to a specific stack.
    Active bool
    Whether the webhook is active and will receive deliveries.
    DisplayName string
    The human-readable display name shown in the UI.
    Name string
    The unique identifier name for the webhook within its scope.
    OrganizationName string
    The organization that owns this webhook.
    PayloadUrl string
    The URL to which webhook payloads are delivered.
    EnvName string
    The environment name. Set when the webhook is scoped to a specific environment.
    Filters []string
    Specific event types this webhook subscribes to. If empty, all events are delivered.
    Format string
    The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
    Groups []string
    Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
    ProjectName string
    The project name. Set when the webhook is scoped to a specific stack.
    Secret string
    Secret will be omitted when returned from the service.
    StackName string
    The stack name. Set when the webhook is scoped to a specific stack.
    active bool
    Whether the webhook is active and will receive deliveries.
    display_name string
    The human-readable display name shown in the UI.
    name string
    The unique identifier name for the webhook within its scope.
    organization_name string
    The organization that owns this webhook.
    payload_url string
    The URL to which webhook payloads are delivered.
    env_name string
    The environment name. Set when the webhook is scoped to a specific environment.
    filters list(string)
    Specific event types this webhook subscribes to. If empty, all events are delivered.
    format string
    The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
    groups list(string)
    Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
    project_name string
    The project name. Set when the webhook is scoped to a specific stack.
    secret string
    Secret will be omitted when returned from the service.
    stack_name string
    The stack name. Set when the webhook is scoped to a specific stack.
    active Boolean
    Whether the webhook is active and will receive deliveries.
    displayName String
    The human-readable display name shown in the UI.
    name String
    The unique identifier name for the webhook within its scope.
    organizationName String
    The organization that owns this webhook.
    payloadUrl String
    The URL to which webhook payloads are delivered.
    envName String
    The environment name. Set when the webhook is scoped to a specific environment.
    filters List<String>
    Specific event types this webhook subscribes to. If empty, all events are delivered.
    format String
    The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
    groups List<String>
    Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
    projectName String
    The project name. Set when the webhook is scoped to a specific stack.
    secret String
    Secret will be omitted when returned from the service.
    stackName String
    The stack name. Set when the webhook is scoped to a specific stack.
    active boolean
    Whether the webhook is active and will receive deliveries.
    displayName string
    The human-readable display name shown in the UI.
    name string
    The unique identifier name for the webhook within its scope.
    organizationName string
    The organization that owns this webhook.
    payloadUrl string
    The URL to which webhook payloads are delivered.
    envName string
    The environment name. Set when the webhook is scoped to a specific environment.
    filters string[]
    Specific event types this webhook subscribes to. If empty, all events are delivered.
    format string
    The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
    groups string[]
    Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
    projectName string
    The project name. Set when the webhook is scoped to a specific stack.
    secret string
    Secret will be omitted when returned from the service.
    stackName string
    The stack name. Set when the webhook is scoped to a specific stack.
    active bool
    Whether the webhook is active and will receive deliveries.
    display_name str
    The human-readable display name shown in the UI.
    name str
    The unique identifier name for the webhook within its scope.
    organization_name str
    The organization that owns this webhook.
    payload_url str
    The URL to which webhook payloads are delivered.
    env_name str
    The environment name. Set when the webhook is scoped to a specific environment.
    filters Sequence[str]
    Specific event types this webhook subscribes to. If empty, all events are delivered.
    format str
    The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
    groups Sequence[str]
    Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
    project_name str
    The project name. Set when the webhook is scoped to a specific stack.
    secret str
    Secret will be omitted when returned from the service.
    stack_name str
    The stack name. Set when the webhook is scoped to a specific stack.
    active Boolean
    Whether the webhook is active and will receive deliveries.
    displayName String
    The human-readable display name shown in the UI.
    name String
    The unique identifier name for the webhook within its scope.
    organizationName String
    The organization that owns this webhook.
    payloadUrl String
    The URL to which webhook payloads are delivered.
    envName String
    The environment name. Set when the webhook is scoped to a specific environment.
    filters List<String>
    Specific event types this webhook subscribes to. If empty, all events are delivered.
    format String
    The format of the webhook payload (e.g., 'raw', 'slack', 'ms_teams').
    groups List<String>
    Event groups this webhook subscribes to (e.g., 'stacks', 'deployments').
    projectName String
    The project name. Set when the webhook is scoped to a specific stack.
    secret String
    Secret will be omitted when returned from the service.
    stackName String
    The stack name. Set when the webhook is scoped to a specific stack.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationWebhook resource produces the following output properties:

    HasSecret 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretCiphertext string
    SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP
    HasSecret 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretCiphertext string
    SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP
    has_secret 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.
    id string
    The provider-assigned unique ID for this managed resource.
    secret_ciphertext string
    SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP
    hasSecret Boolean
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    secretCiphertext String
    SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP
    hasSecret boolean
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    secretCiphertext string
    SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP
    has_secret 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.
    id str
    The provider-assigned unique ID for this managed resource.
    secret_ciphertext str
    SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP
    hasSecret Boolean
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    secretCiphertext String
    SecretCiphertext is the ciphertext value of the webhook's secret. It's used to check whether the secret was changed by the PSP

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-pulumiservice

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial