Emails. Done.

Template Stable

API key created

Sent when an API key is created.

api-key-created - notification

v1
developer Stable Latest stable

API key created v1

api-key-created - v1

Subject: API key created

Preheader: A new API key has been created.

Required fields

No fields.

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters		 Manage API keys
actionButton.url url No Action Button URL
Max 2048 characters		 https://example.com/app
apiKeyDetails detailsTable No API key details
Details table keys: name, createdAt (datetime), environment, createdBy		 {"name":"Name","createdAt":"Created At","environment":"Environment","createdBy":"Created By"}
heading text No Heading
Max 180 characters		 API key created
intro text No Intro
Max 1000 characters		 A new API key has been created.
notice text No Notice
Max 1000 characters		 Keep API keys secure and do not share them publicly.
preheader text No Preheader
Max 220 characters		 A new API key has been created.
subject text No Subject
Max 180 characters		 API key created

Defaults

{
  "actionButton.label": "Manage API keys",
  "heading": "API key created",
  "intro": "A new API key has been created.",
  "notice": "Keep API keys secure and do not share them publicly.",
  "preheader": "A new API key has been created.",
  "subject": "API key created"
}

Example data

{
  "templateId": "api-key-created",
  "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 invalid_details_table API key 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 Notice 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.