Emails. Done.

Template Stable

Report ready

Sent when a report is ready.

report-ready - notification

v1
notification Stable Latest stable

Report ready v1

report-ready - v1

Subject: Your report is ready

Preheader: View your completed report.

Required fields

Name Type Required Description Example
actionButton.url url Yes Action Button URL
Max 2048 characters		 https://example.com/app

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters		 View report
heading text No Heading
Max 180 characters		 Your report is ready
intro text No Intro
Max 1000 characters		 The report you requested is ready.
preheader text No Preheader
Max 220 characters		 View your completed report.
reportDetails detailsTable No Report details
Details table keys: name, createdAt (datetime), period		 {"name":"Name","createdAt":"Created At","period":"Period"}
subject text No Subject
Max 180 characters		 Your report is ready

Defaults

{
  "actionButton.label": "View report",
  "heading": "Your report is ready",
  "intro": "The report you requested is ready.",
  "preheader": "View your completed report.",
  "subject": "Your report is ready"
}

Example data

{
  "templateId": "report-ready",
  "data": {
    "actionButton": {
      "url": "https://example.com/app"
    }
  }
}

Template messages

TypeCodeMessage
Return accepted Valid template data can be queued by the send endpoint.
Error missing_required_variable Action Button URL is required.
Error field_too_long Action Button URL must be 2048 characters or fewer.
Error invalid_url Action Button URL must be a valid http or https URL.
Error field_too_long Action Button Label must be 120 characters or fewer.
Error field_too_long Heading must be 180 characters or fewer.
Error field_too_long Intro must be 1000 characters or fewer.
Error field_too_long Preheader must be 220 characters or fewer.
Error invalid_details_table Report details must be an object whose documented table keys are strings, numbers, or booleans.
Error field_too_long Subject must be 180 characters or fewer.