1. Registry
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. AlertRuleWebhookNotification
Viewing docs for Vercel v5.21.1
published on Thursday, Oct 15, 2026 by Pulumiverse
vercel logo vercel logo
Viewing docs for Vercel v5.21.1
published on Thursday, Oct 15, 2026 by Pulumiverse

    Manages a link between a Vercel alert rule and one existing account webhook.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vercel from "@pulumiverse/vercel";
    
    const alerts = new vercel.Webhook("alerts", {
        endpoint: "https://example.com/vercel-alerts",
        events: ["alerts.triggered"],
    });
    const alertsAlertRuleWebhookNotification = new vercel.AlertRuleWebhookNotification("alerts", {
        alertRuleId: "ar_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        webhookId: alerts.id,
    });
    
    import pulumi
    import pulumiverse_vercel as vercel
    
    alerts = vercel.Webhook("alerts",
        endpoint="https://example.com/vercel-alerts",
        events=["alerts.triggered"])
    alerts_alert_rule_webhook_notification = vercel.AlertRuleWebhookNotification("alerts",
        alert_rule_id="ar_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        webhook_id=alerts.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-vercel/sdk/v5/go/vercel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		alerts, err := vercel.NewWebhook(ctx, "alerts", &vercel.WebhookArgs{
    			Endpoint: pulumi.String("https://example.com/vercel-alerts"),
    			Events: pulumi.StringArray{
    				pulumi.String("alerts.triggered"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vercel.NewAlertRuleWebhookNotification(ctx, "alerts", &vercel.AlertRuleWebhookNotificationArgs{
    			AlertRuleId: pulumi.String("ar_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"),
    			WebhookId:   alerts.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vercel = Pulumiverse.Vercel;
    
    return await Deployment.RunAsync(() => 
    {
        var alerts = new Vercel.Webhook("alerts", new()
        {
            Endpoint = "https://example.com/vercel-alerts",
            Events = new[]
            {
                "alerts.triggered",
            },
        });
    
        var alertsAlertRuleWebhookNotification = new Vercel.AlertRuleWebhookNotification("alerts", new()
        {
            AlertRuleId = "ar_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            WebhookId = alerts.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumiverse.vercel.Webhook;
    import com.pulumiverse.vercel.WebhookArgs;
    import com.pulumiverse.vercel.AlertRuleWebhookNotification;
    import com.pulumiverse.vercel.AlertRuleWebhookNotificationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var alerts = new Webhook("alerts", WebhookArgs.builder()
                .endpoint("https://example.com/vercel-alerts")
                .events("alerts.triggered")
                .build());
    
            var alertsAlertRuleWebhookNotification = new AlertRuleWebhookNotification("alertsAlertRuleWebhookNotification", AlertRuleWebhookNotificationArgs.builder()
                .alertRuleId("ar_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
                .webhookId(alerts.id())
                .build());
    
        }
    }
    
    resources:
      alerts:
        type: vercel:Webhook
        properties:
          endpoint: https://example.com/vercel-alerts
          events:
            - alerts.triggered
      alertsAlertRuleWebhookNotification:
        type: vercel:AlertRuleWebhookNotification
        name: alerts
        properties:
          alertRuleId: ar_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          webhookId: ${alerts.id}
    
    Example coming soon!
    

    Destination requirements

    Each resource owns one link. Do not manage the same alert-rule and webhook pair in multiple Terraform resources or states.

    The webhook must subscribe to alerts.triggered, must not set project_ids, and must be owned by the account. Configure it separately with vercel.Webhook, then pass its ID to webhook_id.

    The special ar_default alert rule ID is supported even though the default rule itself cannot be managed by vercel.AlertRule.

    Create AlertRuleWebhookNotification Resource

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

    Constructor syntax

    new AlertRuleWebhookNotification(name: string, args: AlertRuleWebhookNotificationArgs, opts?: CustomResourceOptions);
    @overload
    def AlertRuleWebhookNotification(resource_name: str,
                                     args: AlertRuleWebhookNotificationArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def AlertRuleWebhookNotification(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     alert_rule_id: Optional[str] = None,
                                     webhook_id: Optional[str] = None,
                                     minimum_severity_level: Optional[str] = None,
                                     team_id: Optional[str] = None)
    func NewAlertRuleWebhookNotification(ctx *Context, name string, args AlertRuleWebhookNotificationArgs, opts ...ResourceOption) (*AlertRuleWebhookNotification, error)
    public AlertRuleWebhookNotification(string name, AlertRuleWebhookNotificationArgs args, CustomResourceOptions? opts = null)
    public AlertRuleWebhookNotification(String name, AlertRuleWebhookNotificationArgs args)
    public AlertRuleWebhookNotification(String name, AlertRuleWebhookNotificationArgs args, CustomResourceOptions options)
    
    type: vercel:AlertRuleWebhookNotification
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "vercel_alert_rule_webhook_notification" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AlertRuleWebhookNotificationArgs
    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 AlertRuleWebhookNotificationArgs
    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 AlertRuleWebhookNotificationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlertRuleWebhookNotificationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlertRuleWebhookNotificationArgs
    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 alertRuleWebhookNotificationResource = new Vercel.AlertRuleWebhookNotification("alertRuleWebhookNotificationResource", new()
    {
        AlertRuleId = "string",
        WebhookId = "string",
        MinimumSeverityLevel = "string",
        TeamId = "string",
    });
    
    example, err := vercel.NewAlertRuleWebhookNotification(ctx, "alertRuleWebhookNotificationResource", &vercel.AlertRuleWebhookNotificationArgs{
    	AlertRuleId:          pulumi.String("string"),
    	WebhookId:            pulumi.String("string"),
    	MinimumSeverityLevel: pulumi.String("string"),
    	TeamId:               pulumi.String("string"),
    })
    
    resource "vercel_alert_rule_webhook_notification" "alertRuleWebhookNotificationResource" {
      lifecycle {
        create_before_destroy = true
      }
      alert_rule_id          = "string"
      webhook_id             = "string"
      minimum_severity_level = "string"
      team_id                = "string"
    }
    
    var alertRuleWebhookNotificationResource = new AlertRuleWebhookNotification("alertRuleWebhookNotificationResource", AlertRuleWebhookNotificationArgs.builder()
        .alertRuleId("string")
        .webhookId("string")
        .minimumSeverityLevel("string")
        .teamId("string")
        .build());
    
    alert_rule_webhook_notification_resource = vercel.AlertRuleWebhookNotification("alertRuleWebhookNotificationResource",
        alert_rule_id="string",
        webhook_id="string",
        minimum_severity_level="string",
        team_id="string")
    
    const alertRuleWebhookNotificationResource = new vercel.AlertRuleWebhookNotification("alertRuleWebhookNotificationResource", {
        alertRuleId: "string",
        webhookId: "string",
        minimumSeverityLevel: "string",
        teamId: "string",
    });
    
    type: vercel:AlertRuleWebhookNotification
    properties:
        alertRuleId: string
        minimumSeverityLevel: string
        teamId: string
        webhookId: string
    

    AlertRuleWebhookNotification 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 AlertRuleWebhookNotification resource accepts the following input properties:

    AlertRuleId string
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    WebhookId string
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    MinimumSeverityLevel string
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    TeamId string
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    AlertRuleId string
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    WebhookId string
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    MinimumSeverityLevel string
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    TeamId string
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    alert_rule_id string
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    webhook_id string
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    minimum_severity_level string
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    team_id string
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    alertRuleId String
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    webhookId String
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    minimumSeverityLevel String
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    teamId String
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    alertRuleId string
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    webhookId string
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    minimumSeverityLevel string
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    teamId string
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    alert_rule_id str
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    webhook_id str
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    minimum_severity_level str
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    team_id str
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    alertRuleId String
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    webhookId String
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    minimumSeverityLevel String
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    teamId String
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AlertRuleWebhookNotification Resource

    Get an existing AlertRuleWebhookNotification resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AlertRuleWebhookNotificationState, opts?: CustomResourceOptions): AlertRuleWebhookNotification
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_rule_id: Optional[str] = None,
            minimum_severity_level: Optional[str] = None,
            team_id: Optional[str] = None,
            webhook_id: Optional[str] = None) -> AlertRuleWebhookNotification
    func GetAlertRuleWebhookNotification(ctx *Context, name string, id IDInput, state *AlertRuleWebhookNotificationState, opts ...ResourceOption) (*AlertRuleWebhookNotification, error)
    public static AlertRuleWebhookNotification Get(string name, Input<string> id, AlertRuleWebhookNotificationState? state, CustomResourceOptions? opts = null)
    public static AlertRuleWebhookNotification get(String name, Output<String> id, AlertRuleWebhookNotificationState state, CustomResourceOptions options)
    resources:  _:    type: vercel:AlertRuleWebhookNotification    get:      id: ${id}
    import {
      to = vercel_alert_rule_webhook_notification.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlertRuleId string
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    MinimumSeverityLevel string
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    TeamId string
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    WebhookId string
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    AlertRuleId string
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    MinimumSeverityLevel string
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    TeamId string
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    WebhookId string
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    alert_rule_id string
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    minimum_severity_level string
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    team_id string
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    webhook_id string
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    alertRuleId String
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    minimumSeverityLevel String
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    teamId String
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    webhookId String
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    alertRuleId string
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    minimumSeverityLevel string
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    teamId string
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    webhookId string
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    alert_rule_id str
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    minimum_severity_level str
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    team_id str
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    webhook_id str
    The ID of an existing account webhook subscribed to the alerts.triggered event.
    alertRuleId String
    The ID of the alert rule. Use ar_default to manage a notification destination for the team's default rule.
    minimumSeverityLevel String
    Set to critical to notify this destination only when an alert is classified as Critical. For custom alert rules, Critical is assigned after the agent investigation completes. Omit to notify this destination at every severity.
    teamId String
    The ID of the team that owns the alert rule and notification destination. Required if a default team is not configured in the provider.
    webhookId String
    The ID of an existing account webhook subscribed to the alerts.triggered event.

    Import

    The pulumi import command can be used, for example:

    If a default team is configured in the provider, import using:

    $ pulumi import vercel:index/alertRuleWebhookNotification:AlertRuleWebhookNotification alerts ar_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/hook_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    

    Otherwise, prefix the import ID with the team ID:

    $ pulumi import vercel:index/alertRuleWebhookNotification:AlertRuleWebhookNotification alerts team_xxxxxxxxxxxxxxxxxxxxxxxx/ar_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/hook_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo vercel logo
    Viewing docs for Vercel v5.21.1
    published on Thursday, Oct 15, 2026 by Pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial