Fix screenshot apps payload shape

mconnell · mconnell · commit 5484b015b3a7 · 2026-03-31T16:29:54.000+01:00
diff --git a/README.md b/README.md
@@ -48,24 +48,33 @@ Create a screenshot submission for all default apps:
 ```ruby
 submission = PreflightQA::Screenshots.create(
   subject: "My Test Email",
-  html: "<html><body>Hello world</body></html>",
-  webhook_url: "https://example.com/preflight/webhook"
+  html: "<html><body>Hello world</body></html>"
 )
 
 submission.uuid
 submission.status
 submission.code
 ```
 
+`webhook_url` is optional. If you want PreflightQA to notify your app when rendering is finished, pass it explicitly:
+
+```ruby
+submission = PreflightQA::Screenshots.create(
+  subject: "My Test Email",
+  html: "<html><body>Hello world</body></html>",
+  webhook_url: "https://example.com/preflight/webhook"
+)
+```
+
 You can also limit the request to specific apps and modes:
 
 ```ruby
 submission = PreflightQA::Screenshots.create(
   subject: "My Test Email",
   html: "<html><body>Hello world</body></html>",
   apps: {
-    apple_mail_mac: [:light, :dark],
-    outlook_mac: [:light]
+    apple_mail_mac: { modes: [:light, :dark] },
+    outlook_mac: { modes: [:light] }
   }
 )
 ```
diff --git a/lib/preflight_qa/screenshots.rb b/lib/preflight_qa/screenshots.rb
@@ -54,7 +54,7 @@ def normalize_apps(apps)
       raise ArgumentError, "apps must be a hash of app keys to mode arrays" unless apps.is_a?(Hash)
 
       apps.each_with_object({}) do |(app, modes), normalized|
-        normalized[app.to_s] = normalize_modes(modes)
+        normalized[app.to_s] = { modes: normalize_modes(modes) }
       end
     end
     private_class_method :normalize_apps
diff --git a/spec/preflight_qa/screenshots_spec.rb b/spec/preflight_qa/screenshots_spec.rb
@@ -43,7 +43,7 @@
       body: {
         subject: "My Test Email",
         html: "<html>test</html>",
-        apps: { "apple_mail_mac" => %w[light dark] },
+        apps: { "apple_mail_mac" => { modes: %w[light dark] } },
         webhook_url: "https://example.test/webhook",
         locale: "en-GB"
       }

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@`
`43`	`43`	`body: {`
`44`	`44`	`subject: "My Test Email",`
`45`	`45`	`html: "<html>test</html>",`
`46`		`- apps: { "apple_mail_mac" => %w[light dark] },`
	`46`	`+ apps: { "apple_mail_mac" => { modes: %w[light dark] } },`
`47`	`47`	`webhook_url: "https://example.test/webhook",`
`48`	`48`	`locale: "en-GB"`
`49`	`49`	`}`