Template Stable

Job complete

Sent when a background job completes.

job-complete - notification

notification Stable Latest stable

Job complete v1

job-complete - v1

Subject: Job complete

Preheader: Your job has completed.

Required fields

No fields.

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters
View result
actionButton.url url No Action Button URL
Max 2048 characters
https://example.com/app
heading text No Heading
Max 180 characters
Job complete
jobDetails detailsTable No Job details
Details table keys: jobName, completedAt (datetime), duration, reference
{"jobName":"Job Name","completedAt":"Completed At","duration":"Duration","reference":"Reference"}
message text No Message
Max 1000 characters
Your job has completed.
preheader text No Preheader
Max 220 characters
Your job has completed.
subject text No Subject
Max 180 characters
Job complete

Defaults

{
  "actionButton.label": "View result",
  "heading": "Job complete",
  "message": "Your job has completed.",
  "preheader": "Your job has completed.",
  "subject": "Job complete"
}

Example data

{
  "templateId": "job-complete",
  "data": {}
}

Template messages

TypeCodeMessage
Return accepted Valid template data can be queued by the send endpoint.
Error field_too_long Action Button Label must be 120 characters or fewer.
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 Heading must be 180 characters or fewer.
Error invalid_details_table Job details must be an object whose documented table keys are strings, numbers, or booleans.
Error field_too_long Message 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.