Template Stable

Generation complete

Sent when generated content is ready.

generation-complete - notification

notification Stable Latest stable

Generation complete v1

generation-complete - v1

Subject: Generation complete

Preheader: Your generated result is ready.

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 result
generationDetails detailsTable No Generation details
Details table keys: completedAt (datetime), type, reference
{"completedAt":"Completed At","type":"Type","reference":"Reference"}
heading text No Heading
Max 180 characters
Generation complete
intro text No Intro
Max 1000 characters
Your generated result is ready.
preheader text No Preheader
Max 220 characters
Your generated result is ready.
subject text No Subject
Max 180 characters
Generation complete

Defaults

{
  "actionButton.label": "View result",
  "heading": "Generation complete",
  "intro": "Your generated result is ready.",
  "preheader": "Your generated result is ready.",
  "subject": "Generation complete"
}

Example data

{
  "templateId": "generation-complete",
  "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 invalid_details_table Generation details must be an object whose documented table keys are strings, numbers, or booleans.
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 field_too_long Subject must be 180 characters or fewer.