Merge pull request #333 from PagerDuty/deprecate_webhook_field

Add comment indicating IncidentDetails.Description is deprecated
PagerDuty · Oct 9, 2021 · 906d87d · 906d87d
2 parents 9326bd9 + eeb0801
commit 906d87d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/webhook.go b/webhook.go
@@ -28,8 +28,10 @@ type IncidentDetails struct {
 	ResolveReason        *string           `json:"resolve_reason"`
 	AlertCounts          AlertCounts       `json:"alert_counts"`
 	Metadata             interface{}       `json:"metadata"`
-	Description          string            `json:"description"`
 	Alerts               []IncidentAlert   `json:"alerts,omitempty"`
+
+	// Description is deprecated, use Title instead.
+	Description string `json:"description"`
 }
 
 // WebhookPayloadMessages is the wrapper around the Webhook payloads. The Array may contain multiple message elements if webhook firing actions occurred in quick succession