Allow to set the retry setting in all webhooks (#665)

tomasmik · web-flow · commit 7498c3a91263 · 2025-09-10T10:47:29.000+03:00
* Allow to set the retry setting in all webhooks

* use optional bool
diff --git a/docs/data-sources/named_webhook.md b/docs/data-sources/named_webhook.md
@@ -26,5 +26,6 @@ description: |-
 - `id` (String) The ID of this resource.
 - `labels` (Set of String) labels for the webhook to use when referring in policies or filtering them
 - `name` (String) the name for the webhook which will also be used to generate the id
+- `retry_on_failure` (Boolean) whether to retry the webhook in case of failure
 - `secret_header_keys` (Set of String) secret header keys which are currently set for this webhook
 - `space_id` (String) ID of the space the webhook is in
diff --git a/docs/data-sources/webhook.md b/docs/data-sources/webhook.md
@@ -35,3 +35,4 @@ data "spacelift_webhook" "webhook" {
 - `enabled` (Boolean) enables or disables sending webhooks
 - `endpoint` (String) endpoint to send the POST request to
 - `id` (String) The ID of this resource.
+- `retry_on_failure` (Boolean) whether to retry the webhook in case of failure
diff --git a/docs/resources/audit_trail_webhook.md b/docs/resources/audit_trail_webhook.md
@@ -33,6 +33,7 @@ resource "spacelift_audit_trail_webhook" "example" {
 
 - `custom_headers` (Map of String) `custom_headers` is a Map of key-value strings, that will be passed as headers with audit trail requests.
 - `include_runs` (Boolean) `include_runs` determines whether the webhook should include information about the run that triggered the event.
+- `retry_on_failure` (Boolean) whether to retry the webhook in case of failure. Defaults to `false`.
 
 ### Read-Only
 
diff --git a/docs/resources/named_webhook.md b/docs/resources/named_webhook.md
@@ -25,6 +25,7 @@ description: |-
 ### Optional
 
 - `labels` (Set of String) labels for the webhook to use when referring in policies or filtering them
+- `retry_on_failure` (Boolean) whether to retry the webhook in case of failure. Defaults to `false`.
 - `secret` (String, Sensitive) secret used to sign each request so you're able to verify that the request comes from us. Defaults to an empty value. Note that once it's created, it will be just an empty string in the state due to security reasons.
 
 ### Read-Only
diff --git a/docs/resources/webhook.md b/docs/resources/webhook.md
@@ -30,6 +30,7 @@ resource "spacelift_webhook" "webhook" {
 
 - `enabled` (Boolean) enables or disables sending webhooks. Defaults to `true`.
 - `module_id` (String) ID of the module which triggers the webhooks
+- `retry_on_failure` (Boolean) whether to retry the webhook in case of failure. Defaults to `false`.
 - `secret` (String, Sensitive) secret used to sign each POST request so you're able to verify that the request comes from us. Defaults to an empty value. Note that once it's created, it will be just an empty string in the state due to security reasons.
 - `stack_id` (String) ID of the stack which triggers the webhooks
 
diff --git a/spacelift/data_named_webhook.go b/spacelift/data_named_webhook.go
@@ -63,6 +63,11 @@ func dataNamedWebhook() *schema.Resource {
 				Required:         true,
 				ValidateDiagFunc: validations.DisallowEmptyString,
 			},
+			"retry_on_failure": {
+				Type:        schema.TypeBool,
+				Description: "whether to retry the webhook in case of failure",
+				Computed:    true,
+			},
 		},
 	}
 }
@@ -88,6 +93,7 @@ func dataNamedWebhookRead(ctx context.Context, d *schema.ResourceData, meta inte
 	d.Set("endpoint", wh.Endpoint)
 	d.Set("enabled", wh.Enabled)
 	d.Set("space_id", wh.Space.ID)
+	d.Set("retry_on_failure", wh.RetryOnFailure)
 
 	labels := schema.NewSet(schema.HashString, []interface{}{})
 	for _, label := range wh.Labels {
diff --git a/spacelift/data_named_webhook_test.go b/spacelift/data_named_webhook_test.go
@@ -15,12 +15,13 @@ func TestNamedWebhookData(t *testing.T) {
 	testSteps(t, []resource.TestStep{{
 		Config: fmt.Sprintf(`
 				resource "spacelift_named_webhook" "test" {
-					endpoint = "https://bacon.org"
-					space_id = "root"
-					name     = "%s"
-					labels   = ["1", "2"]
-					secret   = "super-secret"
-					enabled  = true
+					endpoint         = "https://bacon.org"
+					space_id         = "root"
+					name             = "%s"
+					labels           = ["1", "2"]
+					secret           = "super-secret"
+					enabled          = true
+					retry_on_failure = false
 				}
 
 				resource "spacelift_named_webhook_secret_header" "test-secret" {
diff --git a/spacelift/data_webhook.go b/spacelift/data_webhook.go
@@ -47,6 +47,11 @@ func dataWebhook() *schema.Resource {
 				Required:         true,
 				ValidateDiagFunc: validations.DisallowEmptyString,
 			},
+			"retry_on_failure": {
+				Type:        schema.TypeBool,
+				Description: "whether to retry the webhook in case of failure",
+				Computed:    true,
+			},
 		},
 	}
 }
@@ -91,6 +96,7 @@ func dataModuleWebhookRead(ctx context.Context, d *schema.ResourceData, meta int
 	d.SetId(webhookID)
 	d.Set("enabled", module.Integrations.Webhooks[webhookIndex].Enabled)
 	d.Set("endpoint", module.Integrations.Webhooks[webhookIndex].Endpoint)
+	d.Set("retry_on_failure", module.Integrations.Webhooks[webhookIndex].RetryOnFailure)
 
 	return nil
 }
@@ -126,6 +132,7 @@ func dataStackWebhookRead(ctx context.Context, d *schema.ResourceData, meta inte
 	d.SetId(webhookID)
 	d.Set("enabled", stack.Integrations.Webhooks[webhookIndex].Enabled)
 	d.Set("endpoint", stack.Integrations.Webhooks[webhookIndex].Endpoint)
+	d.Set("retry_on_failure", stack.Integrations.Webhooks[webhookIndex].RetryOnFailure)
 
 	return nil
 }
diff --git a/spacelift/data_webhook_test.go b/spacelift/data_webhook_test.go
@@ -23,9 +23,10 @@ func TestWebhookData(t *testing.T) {
 				}
 
 				resource "spacelift_webhook" "test" {
-					stack_id = spacelift_stack.test.id
-					endpoint = "https://bacon.org"
-					secret   = "very-very-secret"
+					stack_id         = spacelift_stack.test.id
+					endpoint         = "https://bacon.org"
+					secret           = "very-very-secret"
+					retry_on_failure = false
 				}
 
 				data "spacelift_webhook" "test" {
@@ -56,9 +57,10 @@ func TestWebhookData(t *testing.T) {
 				}
 
 				resource "spacelift_webhook" "test" {
-					module_id = spacelift_module.test.id
-					endpoint  = "https://bacon.org"
-					secret    = "very-very-secret"
+					module_id        = spacelift_module.test.id
+					endpoint         = "https://bacon.org"
+					secret           = "very-very-secret"
+					retry_on_failure = false
 				}
 
 				data "spacelift_webhook" "test" {
diff --git a/spacelift/internal/structs/audit_trail_webhook.go b/spacelift/internal/structs/audit_trail_webhook.go
@@ -7,8 +7,9 @@ type AuditTrailWebhook struct {
 }
 
 type AuditTrailWebhookRead struct {
-	Enabled     bool   `graphql:"enabled"`
-	Endpoint    string `graphql:"endpoint"`
-	IncludeRuns bool   `graphql:"includeRuns"`
-	Secret      string `graphql:"secret"`
+	Enabled        bool   `graphql:"enabled"`
+	Endpoint       string `graphql:"endpoint"`
+	IncludeRuns    bool   `graphql:"includeRuns"`
+	Secret         string `graphql:"secret"`
+	RetryOnFailure *bool  `graphql:"retryOnFailure"`
 }
diff --git a/spacelift/internal/structs/audit_trail_webhook_input.go b/spacelift/internal/structs/audit_trail_webhook_input.go
@@ -3,11 +3,12 @@ package structs
 import "github.com/shurcooL/graphql"
 
 type AuditTrailWebhookInput struct {
-	Enabled       graphql.Boolean `json:"enabled"`
-	Endpoint      graphql.String  `json:"endpoint"`
-	IncludeRuns   graphql.Boolean `json:"includeRuns"`
-	Secret        graphql.String  `json:"secret"`
-	CustomHeaders *StringMap      `json:"customHeaders"`
+	Enabled        graphql.Boolean  `json:"enabled"`
+	Endpoint       graphql.String   `json:"endpoint"`
+	IncludeRuns    graphql.Boolean  `json:"includeRuns"`
+	Secret         graphql.String   `json:"secret"`
+	CustomHeaders  *StringMap       `json:"customHeaders"`
+	RetryOnFailure *graphql.Boolean `json:"retryOnFailure"`
 }
 
 type StringMap struct {
diff --git a/spacelift/internal/structs/integrations.go b/spacelift/internal/structs/integrations.go
@@ -21,9 +21,10 @@ type Integrations struct {
 		TokenScopes         []string `graphql:"tokenScopes"`
 	} `graphql:"gcp"`
 	Webhooks []struct {
-		ID       string `graphql:"id"`
-		Enabled  bool   `graphql:"enabled"`
-		Endpoint string `graphql:"endpoint"`
-		Secret   string `graphql:"secret"`
+		ID             string `graphql:"id"`
+		Enabled        bool   `graphql:"enabled"`
+		Endpoint       string `graphql:"endpoint"`
+		Secret         string `graphql:"secret"`
+		RetryOnFailure *bool  `graphql:"retryOnFailure"`
 	} `graphql:"webhooks"`
 }
diff --git a/spacelift/internal/structs/named_webhook_input.go b/spacelift/internal/structs/named_webhook_input.go
@@ -4,24 +4,26 @@ import "github.com/shurcooL/graphql"
 
 // WebhooksIntegration represents the input required to create or update a webhook.
 type NamedWebhooksIntegration struct {
-	ID            string   `graphql:"id" json:"id"`
-	Enabled       bool     `graphql:"enabled" json:"enabled"`
-	Endpoint      string   `graphql:"endpoint" json:"endpoint"`
-	Space         Space    `graphql:"space" json:"space"`
-	Name          string   `graphql:"name" json:"name"`
-	Secret        *string  `graphql:"secret" json:"secret"`
-	SecretHeaders []string `graphql:"secretHeaders" json:"secretHeaders"`
-	Labels        []string `graphql:"labels" json:"labels"`
+	ID             string   `graphql:"id" json:"id"`
+	Enabled        bool     `graphql:"enabled" json:"enabled"`
+	Endpoint       string   `graphql:"endpoint" json:"endpoint"`
+	Space          Space    `graphql:"space" json:"space"`
+	Name           string   `graphql:"name" json:"name"`
+	Secret         *string  `graphql:"secret" json:"secret"`
+	SecretHeaders  []string `graphql:"secretHeaders" json:"secretHeaders"`
+	Labels         []string `graphql:"labels" json:"labels"`
+	RetryOnFailure *bool    `graphql:"retryOnFailure" json:"retryOnFailure"`
 }
 
 // WebhooksIntegrationInput represents the input required to create or update a webhook.
 type NamedWebhooksIntegrationInput struct {
-	Enabled  graphql.Boolean  `json:"enabled"`
-	Endpoint graphql.String   `json:"endpoint"`
-	Space    graphql.ID       `json:"space"`
-	Name     graphql.String   `json:"name"`
-	Secret   *graphql.String  `json:"secret"`
-	Labels   []graphql.String `json:"labels"`
+	Enabled        graphql.Boolean  `json:"enabled"`
+	Endpoint       graphql.String   `json:"endpoint"`
+	Space          graphql.ID       `json:"space"`
+	Name           graphql.String   `json:"name"`
+	Secret         *graphql.String  `json:"secret"`
+	Labels         []graphql.String `json:"labels"`
+	RetryOnFailure *graphql.Boolean `json:"retryOnFailure"`
 }
 
 // NamedWebhookHeaderInput represents the input required to set a secret header.
diff --git a/spacelift/internal/structs/webhook_input.go b/spacelift/internal/structs/webhook_input.go
@@ -4,7 +4,8 @@ import "github.com/shurcooL/graphql"
 
 // WebhooksIntegrationInput represents the input required to create or update a webhook.
 type WebhooksIntegrationInput struct {
-	Enabled  graphql.Boolean `json:"enabled"`
-	Endpoint graphql.String  `json:"endpoint"`
-	Secret   graphql.String  `json:"secret"`
+	Enabled        graphql.Boolean  `json:"enabled"`
+	Endpoint       graphql.String   `json:"endpoint"`
+	Secret         graphql.String   `json:"secret"`
+	RetryOnFailure *graphql.Boolean `json:"retryOnFailure"`
 }
diff --git a/spacelift/resource_audit_trail_webhook.go b/spacelift/resource_audit_trail_webhook.go
@@ -56,6 +56,12 @@ func resourceAuditTrailWebhook() *schema.Resource {
 				Optional:    true,
 				Description: "`custom_headers` is a Map of key-value strings, that will be passed as headers with audit trail requests.",
 			},
+			"retry_on_failure": {
+				Type:        schema.TypeBool,
+				Description: "whether to retry the webhook in case of failure. Defaults to `false`.",
+				Optional:    true,
+				Default:     false,
+			},
 		},
 	}
 }
@@ -64,14 +70,20 @@ func resourceAuditTrailWebhookCreate(ctx context.Context, data *schema.ResourceD
 	var mutation struct {
 		AuditTrailWebhook *structs.AuditTrailWebhookRead `graphql:"auditTrailSetWebhook(input: $input)"`
 	}
+	input := structs.AuditTrailWebhookInput{
+		Enabled:       toBool(data.Get("enabled")),
+		Endpoint:      toString(data.Get("endpoint")),
+		IncludeRuns:   toBool(data.Get("include_runs")),
+		Secret:        toString(data.Get("secret")),
+		CustomHeaders: toOptionalStringMap(data.Get("custom_headers")),
+	}
+
+	if retryOnFailure, ok := data.GetOk("retry_on_failure"); ok {
+		input.RetryOnFailure = toOptionalBool(retryOnFailure)
+	}
+
 	variables := map[string]interface{}{
-		"input": structs.AuditTrailWebhookInput{
-			Enabled:       toBool(data.Get("enabled")),
-			Endpoint:      toString(data.Get("endpoint")),
-			IncludeRuns:   toBool(data.Get("include_runs")),
-			Secret:        toString(data.Get("secret")),
-			CustomHeaders: toOptionalStringMap(data.Get("custom_headers")),
-		},
+		"input": input,
 	}
 	if err := i.(*internal.Client).Mutate(ctx, "AuditTrailWebhookCreate", &mutation, variables); err != nil {
 		return diag.Errorf("could not create audit trail webhook: %v", internal.FromSpaceliftError(err))
@@ -99,6 +111,7 @@ func resourceAuditTrailWebhookRead(ctx context.Context, data *schema.ResourceDat
 	data.Set("endpoint", query.AuditTrailWebhook.Endpoint)
 	data.Set("include_runs", query.AuditTrailWebhook.IncludeRuns)
 	data.Set("secret", "")
+	data.Set("retry_on_failure", query.AuditTrailWebhook.RetryOnFailure)
 
 	return nil
 }
@@ -107,13 +120,19 @@ func resourceAuditTrailWebhookUpdate(ctx context.Context, data *schema.ResourceD
 	var mutation struct {
 		AuditTrailWebhook *structs.AuditTrailWebhookRead `graphql:"auditTrailSetWebhook(input: $input)"`
 	}
+	input := structs.AuditTrailWebhookInput{
+		Enabled:       toBool(data.Get("enabled")),
+		Endpoint:      toString(data.Get("endpoint")),
+		IncludeRuns:   toBool(data.Get("include_runs")),
+		CustomHeaders: toOptionalStringMap(data.Get("custom_headers")),
+	}
+
+	if retryOnFailure, ok := data.GetOk("retry_on_failure"); ok {
+		input.RetryOnFailure = toOptionalBool(retryOnFailure)
+	}
+
 	variables := map[string]interface{}{
-		"input": structs.AuditTrailWebhookInput{
-			Enabled:       toBool(data.Get("enabled")),
-			Endpoint:      toString(data.Get("endpoint")),
-			IncludeRuns:   toBool(data.Get("include_runs")),
-			CustomHeaders: toOptionalStringMap(data.Get("custom_headers")),
-		},
+		"input": input,
 	}
 	if err := i.(*internal.Client).Mutate(ctx, "AuditTrailWebhookUpdate", &mutation, variables); err != nil {
 		return diag.Errorf("could not update audit trail webhook: %v", internal.FromSpaceliftError(err))
diff --git a/spacelift/resource_audit_trail_webhook_test.go b/spacelift/resource_audit_trail_webhook_test.go
@@ -16,6 +16,7 @@ resource "spacelift_audit_trail_webhook" "test" {
 	endpoint = "%s"
 	include_runs = true
 	secret = "secret"
+	retry_on_failure = false
 }
 `
 
@@ -25,6 +26,7 @@ resource "spacelift_audit_trail_webhook" "test" {
 	endpoint = "%s"
 	include_runs = true
 	secret = "secret"
+	retry_on_failure = false
 	custom_headers = {
 		"X-Some-Header" = "some-value"
 		"X-Some-Header-2" = "some-value-2"
diff --git a/spacelift/resource_named_webhook.go b/spacelift/resource_named_webhook.go
@@ -68,6 +68,12 @@ func resourceNamedWebhook() *schema.Resource {
 				ForceNew:         true,
 				DiffSuppressFunc: ignoreOnceCreated,
 			},
+			"retry_on_failure": {
+				Type:        schema.TypeBool,
+				Description: "whether to retry the webhook in case of failure. Defaults to `false`.",
+				Optional:    true,
+				Default:     false,
+			},
 		},
 	}
 }
@@ -88,6 +94,10 @@ func resourceNamedWebhookCreate(ctx context.Context, d *schema.ResourceData, met
 		Labels:   []graphql.String{},
 	}
 
+	if retryOnFailure, ok := d.GetOk("retry_on_failure"); ok {
+		input.RetryOnFailure = toOptionalBool(retryOnFailure)
+	}
+
 	if labelSet, ok := d.Get("labels").(*schema.Set); ok {
 		for _, label := range labelSet.List() {
 			input.Labels = append(input.Labels, graphql.String(label.(string)))
@@ -126,6 +136,7 @@ func resourceNamedWebhookRead(ctx context.Context, d *schema.ResourceData, meta
 	d.Set("enabled", wh.Enabled)
 	d.Set("space_id", wh.Space.ID)
 	d.Set("secret", "")
+	d.Set("retry_on_failure", wh.RetryOnFailure)
 
 	labels := schema.NewSet(schema.HashString, []interface{}{})
 	for _, label := range wh.Labels {
@@ -156,16 +167,22 @@ func resourceNamedWebhookUpdate(ctx context.Context, d *schema.ResourceData, met
 		Webhook *structs.NamedWebhooksIntegration `graphql:"namedWebhooksIntegrationUpdate(id: $id, input: $input)"`
 	}
 
+	input := structs.NamedWebhooksIntegrationInput{
+		Enabled:  graphql.Boolean(enabled),
+		Endpoint: graphql.String(endpoint),
+		Secret:   toOptionalString(secret),
+		Name:     graphql.String(name),
+		Space:    graphql.String(spaceID),
+		Labels:   labels,
+	}
+
+	if retryOnFailure, ok := d.GetOk("retry_on_failure"); ok {
+		input.RetryOnFailure = toOptionalBool(retryOnFailure)
+	}
+
 	variables := map[string]interface{}{
-		"id": toID(webhookID),
-		"input": structs.NamedWebhooksIntegrationInput{
-			Enabled:  graphql.Boolean(enabled),
-			Endpoint: graphql.String(endpoint),
-			Secret:   toOptionalString(secret),
-			Name:     graphql.String(name),
-			Space:    graphql.String(spaceID),
-			Labels:   labels,
-		},
+		"id":    toID(webhookID),
+		"input": input,
 	}
 
 	var ret diag.Diagnostics
diff --git a/spacelift/resource_named_webhook_test.go b/spacelift/resource_named_webhook_test.go
diff --git a/spacelift/resource_webhook.go b/spacelift/resource_webhook.go
diff --git a/spacelift/resource_webhook_test.go b/spacelift/resource_webhook_test.go

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,11 @@ func dataWebhook() *schema.Resource {`
`47`	`47`	`Required: true,`
`48`	`48`	`ValidateDiagFunc: validations.DisallowEmptyString,`
`49`	`49`	`},`
	`50`	`+ "retry_on_failure": {`
	`51`	`+ Type: schema.TypeBool,`
	`52`	`+ Description: "whether to retry the webhook in case of failure",`
	`53`	`+ Computed: true,`
	`54`	`+ },`
`50`	`55`	`},`
`51`	`56`	`}`
`52`	`57`	`}`
`@@ -91,6 +96,7 @@ func dataModuleWebhookRead(ctx context.Context, d *schema.ResourceData, meta int`
`91`	`96`	`d.SetId(webhookID)`
`92`	`97`	`d.Set("enabled", module.Integrations.Webhooks[webhookIndex].Enabled)`
`93`	`98`	`d.Set("endpoint", module.Integrations.Webhooks[webhookIndex].Endpoint)`
	`99`	`+ d.Set("retry_on_failure", module.Integrations.Webhooks[webhookIndex].RetryOnFailure)`
`94`	`100`
`95`	`101`	`return nil`
`96`	`102`	`}`
`@@ -126,6 +132,7 @@ func dataStackWebhookRead(ctx context.Context, d *schema.ResourceData, meta inte`
`126`	`132`	`d.SetId(webhookID)`
`127`	`133`	`d.Set("enabled", stack.Integrations.Webhooks[webhookIndex].Enabled)`
`128`	`134`	`d.Set("endpoint", stack.Integrations.Webhooks[webhookIndex].Endpoint)`
	`135`	`+ d.Set("retry_on_failure", stack.Integrations.Webhooks[webhookIndex].RetryOnFailure)`
`129`	`136`
`130`	`137`	`return nil`
`131`	`138`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,10 @@ func TestWebhookData(t *testing.T) {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`resource "spacelift_webhook" "test" {`
`26`		`- stack_id = spacelift_stack.test.id`
`27`		`- endpoint = "https://bacon.org"`
`28`		`- secret = "very-very-secret"`
	`26`	`+ stack_id = spacelift_stack.test.id`
	`27`	`+ endpoint = "https://bacon.org"`
	`28`	`+ secret = "very-very-secret"`
	`29`	`+ retry_on_failure = false`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`data "spacelift_webhook" "test" {`
`@@ -56,9 +57,10 @@ func TestWebhookData(t *testing.T) {`
`56`	`57`	`}`
`57`	`58`
`58`	`59`	`resource "spacelift_webhook" "test" {`
`59`		`- module_id = spacelift_module.test.id`
`60`		`- endpoint = "https://bacon.org"`
`61`		`- secret = "very-very-secret"`
	`60`	`+ module_id = spacelift_module.test.id`
	`61`	`+ endpoint = "https://bacon.org"`
	`62`	`+ secret = "very-very-secret"`
	`63`	`+ retry_on_failure = false`
`62`	`64`	`}`
`63`	`65`
`64`	`66`	`data "spacelift_webhook" "test" {`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,9 @@ type AuditTrailWebhook struct {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`type AuditTrailWebhookRead struct {`
`10`		- Enabled bool `graphql:"enabled"`
`11`		- Endpoint string `graphql:"endpoint"`
`12`		- IncludeRuns bool `graphql:"includeRuns"`
`13`		- Secret string `graphql:"secret"`
	`10`	+ Enabled bool `graphql:"enabled"`
	`11`	+ Endpoint string `graphql:"endpoint"`
	`12`	+ IncludeRuns bool `graphql:"includeRuns"`
	`13`	+ Secret string `graphql:"secret"`
	`14`	+ RetryOnFailure *bool `graphql:"retryOnFailure"`
`14`	`15`	`}`