feat: support oncall webhook presets (#2284)

Author: matiasb

docs/resources/oncall_outgoing_webhook.md

@@ -37,7 +37,6 @@ resource "grafana_oncall_outgoing_webhook" "test-acc-outgoing_webhook" {
 ### Required
 
 - `name` (String) The name of the outgoing webhook.
-- `url` (String) The webhook URL.
 
 ### Optional
 
@@ -49,9 +48,11 @@ resource "grafana_oncall_outgoing_webhook" "test-acc-outgoing_webhook" {
 - `integration_filter` (List of String) Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.
 - `is_webhook_enabled` (Boolean) Controls whether the outgoing webhook will trigger or is ignored. Defaults to `true`.
 - `password` (String, Sensitive) The auth data of the webhook. Used for Basic authentication
+- `preset` (String) The preset of the outgoing webhook. Possible values are: `simple_webhook`, `advanced_webhook`, `grafana_sift`, `incident_webhook`. If no preset is set, the default preset is `advanced_webhook`.
 - `team_id` (String) The ID of the OnCall team (using the `grafana_oncall_team` datasource).
 - `trigger_template` (String) A template used to dynamically determine whether the webhook should execute based on the content of the payload.
-- `trigger_type` (String) The type of event that will cause this outgoing webhook to execute. The types of triggers are: `escalation`, `alert group created`, `acknowledge`, `resolve`, `silence`, `unsilence`, `unresolve`, `unacknowledge`. Defaults to `escalation`.
+- `trigger_type` (String) The type of event that will cause this outgoing webhook to execute. The events available will depend on the preset used. For alert group webhooks, the possible triggers are: `escalation`, `alert group created`, `status change`, `acknowledge`, `resolve`, `silence`, `unsilence`, `unresolve`, `unacknowledge`, `resolution note added`, `personal notification`; for incident webhooks: `incident declared`, `incident changed`, `incident resolved`. Defaults to `escalation`.
+- `url` (String) The webhook URL. Required when not using a preset that controls this field.
 - `user` (String) Username to use when making the outgoing webhook request.
 
 ### Read-Only

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/fatih/color v1.18.0
 	github.com/go-openapi/runtime v0.28.0
 	github.com/go-openapi/strfmt v0.23.0
-	github.com/grafana/amixr-api-go-client v0.0.24 // main branch
+	github.com/grafana/amixr-api-go-client v0.0.25
 	github.com/grafana/authlib/claims v0.0.0-20250120084028-e3328c576437
 	github.com/grafana/fleet-management-api v1.0.0
 	github.com/grafana/grafana-app-sdk v0.35.2-0.20250408075831-c2a87bde0849

go.sum

@@ -172,6 +172,8 @@ github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
 github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
 github.com/grafana/amixr-api-go-client v0.0.24 h1:Yvj8Ir02e3GTcetd+qHmajrLC690YJxK8lppEUkrsyA=
 github.com/grafana/amixr-api-go-client v0.0.24/go.mod h1:ihgLhTVimmjASuZ06y/mQxPcYH3toAIuUVGK6flHsMU=
+github.com/grafana/amixr-api-go-client v0.0.25 h1:tAQeJRuq9ihHotxq6/oEB6lIhuAdM+MUP0uPkNn1I3A=
+github.com/grafana/amixr-api-go-client v0.0.25/go.mod h1:ihgLhTVimmjASuZ06y/mQxPcYH3toAIuUVGK6flHsMU=
 github.com/grafana/authlib/claims v0.0.0-20250120084028-e3328c576437 h1:OlwbIVFcYgMjnQhpbZwRPVNrvZKTodvPMqwb8yEqVW0=
 github.com/grafana/authlib/claims v0.0.0-20250120084028-e3328c576437/go.mod h1:r+F8H6awwjNQt/KPZ2GNwjk8TvsJ7/gxzkXN26GlL/A=
 github.com/grafana/fleet-management-api v1.0.0 h1:twb0kBgeNRcvQi7iDXq7AFhlM2mWcN76kTXleJuPA38=

internal/resources/oncall/resource_outgoing_webhook.go

@@ -10,6 +10,42 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
+// When a preset is defined, certain fields are controlled by that preset and should not be
+// modified by users; these fields are automatically suppressed from diffs when a preset is active.
+// presetControlledFields maps preset names to lists of field names that are controlled by that preset
+var presetControlledFields = map[string][]string{
+	"advanced_webhook": {},
+	"grafana_sift":     {"authorization_header", "data", "forward_whole_payload", "headers", "http_method", "password", "url", "user"},
+	"incident_webhook": {"integration_filter"},
+	"simple_webhook":   {"authorization_header", "data", "forward_whole_payload", "headers", "http_method", "integration_filter", "password", "trigger_template", "trigger_type", "user"},
+}
+
+// isFieldControlledByPreset checks if a field is controlled by the current preset
+func isFieldControlledByPreset(fieldName string, d *schema.ResourceData) bool {
+	if preset, presetOk := d.GetOk("preset"); presetOk {
+		if preset == "" {
+			// If no preset is set, default to advanced_webhook
+			preset = "advanced_webhook"
+		}
+		if controlledFields, exists := presetControlledFields[preset.(string)]; exists {
+			for _, controlledField := range controlledFields {
+				if controlledField == fieldName {
+					return true
+				}
+			}
+		}
+	}
+	return false
+}
+
+// suppressDiffForPresetControlledField is a generic diff suppression function
+// that checks if a field is controlled by the current preset
+func suppressDiffForPresetControlledField(fieldName string) func(k, old, new string, d *schema.ResourceData) bool {
+	return func(k, old, new string, d *schema.ResourceData) bool {
+		return isFieldControlledByPreset(fieldName, d)
+	}
+}
+
 func resourceOutgoingWebhook() *common.Resource {
 	schema := &schema.Resource{
 		Description: `
@@ -29,70 +65,86 @@ func resourceOutgoingWebhook() *common.Resource {
 				Required:    true,
 				Description: "The name of the outgoing webhook.",
 			},
+			"preset": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The preset of the outgoing webhook. Possible values are: `simple_webhook`, `advanced_webhook`, `grafana_sift`, `incident_webhook`. If no preset is set, the default preset is `advanced_webhook`.",
+			},
 			"team_id": {
 				Type:        schema.TypeString,
 				Optional:    true,
 				Description: "The ID of the OnCall team (using the `grafana_oncall_team` datasource).",
 			},
 			"url": {
-				Type:        schema.TypeString,
-				Required:    true,
-				Description: "The webhook URL.",
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "The webhook URL. Required when not using a preset that controls this field.",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("url"),
 			},
 			"data": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "The data of the webhook.",
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "The data of the webhook.",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("data"),
 			},
 			"user": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "Username to use when making the outgoing webhook request.",
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "Username to use when making the outgoing webhook request.",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("user"),
 			},
 			"password": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "The auth data of the webhook. Used for Basic authentication",
-				Sensitive:   true,
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "The auth data of the webhook. Used for Basic authentication",
+				Sensitive:        true,
+				DiffSuppressFunc: suppressDiffForPresetControlledField("password"),
 			},
 			"authorization_header": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "The auth data of the webhook. Used in Authorization header instead of user/password auth.",
-				Sensitive:   true,
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "The auth data of the webhook. Used in Authorization header instead of user/password auth.",
+				Sensitive:        true,
+				DiffSuppressFunc: suppressDiffForPresetControlledField("authorization_header"),
 			},
 			"forward_whole_payload": {
-				Type:        schema.TypeBool,
-				Optional:    true,
-				Description: "Toggle to send the entire webhook payload instead of using the values in the Data field.",
+				Type:             schema.TypeBool,
+				Optional:         true,
+				Description:      "Toggle to send the entire webhook payload instead of using the values in the Data field.",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("forward_whole_payload"),
 			},
 			"trigger_type": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "The type of event that will cause this outgoing webhook to execute. The types of triggers are: `escalation`, `alert group created`, `acknowledge`, `resolve`, `silence`, `unsilence`, `unresolve`, `unacknowledge`.",
-				Default:     "escalation",
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "The type of event that will cause this outgoing webhook to execute. The events available will depend on the preset used. For alert group webhooks, the possible triggers are: `escalation`, `alert group created`, `status change`, `acknowledge`, `resolve`, `silence`, `unsilence`, `unresolve`, `unacknowledge`, `resolution note added`, `personal notification`; for incident webhooks: `incident declared`, `incident changed`, `incident resolved`.",
+				Default:          "escalation",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("trigger_type"),
 			},
 			"http_method": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "The HTTP method used in the request made by the outgoing webhook.",
-				Default:     "POST",
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "The HTTP method used in the request made by the outgoing webhook.",
+				Default:          "POST",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("http_method"),
 			},
 			"trigger_template": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "A template used to dynamically determine whether the webhook should execute based on the content of the payload.",
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "A template used to dynamically determine whether the webhook should execute based on the content of the payload.",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("trigger_template"),
 			},
 			"headers": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "Headers to add to the outgoing webhook request.",
+				Type:             schema.TypeString,
+				Optional:         true,
+				Description:      "Headers to add to the outgoing webhook request.",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("headers"),
 			},
 			"integration_filter": {
-				Type:        schema.TypeList,
-				Elem:        &schema.Schema{Type: schema.TypeString},
-				Optional:    true,
-				Description: "Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.",
+				Type:             schema.TypeList,
+				Elem:             &schema.Schema{Type: schema.TypeString},
+				Optional:         true,
+				Description:      "Restricts the outgoing webhook to only trigger if the event came from a selected integration. If no integrations are selected the outgoing webhook will trigger for any integration.",
+				DiffSuppressFunc: suppressDiffForPresetControlledField("integration_filter"),
 			},
 			"is_webhook_enabled": {
 				Type:        schema.TypeBool,
@@ -127,18 +179,30 @@ func listWebhooks(client *onCallAPI.Client, listOptions onCallAPI.ListOptions) (
 func resourceOutgoingWebhookCreate(ctx context.Context, d *schema.ResourceData, client *onCallAPI.Client) diag.Diagnostics {
 	name := d.Get("name").(string)
 	teamID := d.Get("team_id").(string)
-	url := d.Get("url").(string)
 	forwardWholePayload := d.Get("forward_whole_payload").(bool)
 	isWebhookEnabled := d.Get("is_webhook_enabled").(bool)
 
 	createOptions := &onCallAPI.CreateWebhookOptions{
 		Name:             name,
 		Team:             teamID,
-		Url:              url,
 		ForwardAll:       forwardWholePayload,
 		IsWebhookEnabled: isWebhookEnabled,
 	}
 
+	preset, presetOk := d.GetOk("preset")
+	if presetOk {
+		createOptions.Preset = preset.(string)
+	}
+
+	// Handle URL validation and assignment
+	if !isFieldControlledByPreset("url", d) {
+		url, urlOk := d.GetOk("url")
+		if !urlOk || url == "" {
+			return diag.Errorf("url is required if it is not defined by the preset")
+		}
+		createOptions.Url = url.(string)
+	}
+
 	data, dataOk := d.GetOk("data")
 	if dataOk {
 		dd := data.(string)
@@ -213,6 +277,7 @@ func resourceOutgoingWebhookRead(ctx context.Context, d *schema.ResourceData, cl
 	}
 
 	d.Set("name", outgoingWebhook.Name)
+	d.Set("preset", outgoingWebhook.Preset)
 	d.Set("team_id", outgoingWebhook.Team)
 	d.Set("url", outgoingWebhook.Url)
 	d.Set("data", outgoingWebhook.Data)
@@ -231,18 +296,30 @@ func resourceOutgoingWebhookRead(ctx context.Context, d *schema.ResourceData, cl
 func resourceOutgoingWebhookUpdate(ctx context.Context, d *schema.ResourceData, client *onCallAPI.Client) diag.Diagnostics {
 	name := d.Get("name").(string)
 	teamID := d.Get("team_id").(string)
-	url := d.Get("url").(string)
 	forwardWholePayload := d.Get("forward_whole_payload").(bool)
 	isWebhookEnabled := d.Get("is_webhook_enabled").(bool)
 
 	updateOptions := &onCallAPI.UpdateWebhookOptions{
 		Name:             name,
 		Team:             teamID,
-		Url:              url,
 		ForwardAll:       forwardWholePayload,
 		IsWebhookEnabled: isWebhookEnabled,
 	}
 
+	preset, presetOk := d.GetOk("preset")
+	if presetOk {
+		updateOptions.Preset = preset.(string)
+	}
+
+	// Handle URL validation and assignment
+	if !isFieldControlledByPreset("url", d) {
+		url, urlOk := d.GetOk("url")
+		if !urlOk || url == "" {
+			return diag.Errorf("url is required if it is not defined by the preset")
+		}
+		updateOptions.Url = url.(string)
+	}
+
 	data, dataOk := d.GetOk("data")
 	if dataOk {
 		dd := data.(string)

internal/resources/oncall/resource_outgoing_webhook_test.go

@@ -31,6 +31,25 @@ func TestAccOnCallOutgoingWebhook_basic(t *testing.T) {
 	})
 }
 
+func TestAccOnCallOutgoingWebhook_preset(t *testing.T) {
+	testutils.CheckCloudInstanceTestsEnabled(t)
+
+	webhookName := fmt.Sprintf("name-%s", acctest.RandString(8))
+
+	resource.ParallelTest(t, resource.TestCase{
+		ProtoV5ProviderFactories: testutils.ProtoV5ProviderFactories,
+		CheckDestroy:             testAccCheckOnCallOutgoingWebhookResourceDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccOnCallOutgoingWebhookPresetConfig(webhookName),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckOnCallOutgoingWebhookResourceExists("grafana_oncall_outgoing_webhook.test-acc-outgoing_webhook"),
+				),
+			},
+		},
+	})
+}
+
 func testAccCheckOnCallOutgoingWebhookResourceDestroy(s *terraform.State) error {
 	client := testutils.Provider.Meta().(*common.Client).OnCallClient
 	for _, r := range s.RootModule().Resources {
@@ -65,6 +84,16 @@ resource "grafana_oncall_outgoing_webhook" "test-acc-outgoing_webhook" {
 `, webhookName)
 }
 
+func testAccOnCallOutgoingWebhookPresetConfig(webhookName string) string {
+	return fmt.Sprintf(`
+resource "grafana_oncall_outgoing_webhook" "test-acc-outgoing_webhook" {
+	name = "%s"
+	preset = "simple_webhook"
+	url = "https://example.com"
+}
+`, webhookName)
+}
+
 func testAccCheckOnCallOutgoingWebhookResourceExists(name string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[name]