The following email templates are currently used by The Things Stack:
| Full Name | Identifier | Scope | Additional fields |
|---|---|---|---|
| Tenant Created | tenant_created |
Sent to the initial user of a tenant when it is first created.
|
InitialPassword |
| Invitation | invitation |
Sent when inviting new users to the network. | InvitationToken, TTL |
| API Key changed | api_key_changed |
Sent when the rights of an API Key have been changed. | Key, Rights, ConsoleURL |
| API Key created | api_key_created |
Send when an API Key has been created. | Key, Rights, ConsoleURL |
| Collaborator changed | collaborator_changed |
Sent when the rights of a collaborator have been changed. | Collaborator, ConsoleURL |
| Password changed | password_changed |
Sent when the the password of a user has been changed. | |
| Temporary password | temporary_password |
Sent when a temporary password has been requested for an user. | TemporaryPassword, TTL |
| User Requested | user_requested |
Sent to admins when a user is created and needs to be approved. | ConsoleURL |
| Email validation | validate |
Sent when a user is added as a collaborator of an entity, in order to validate their email. | ID, Token, TTL |
| Entity State Changed | entity_state_changed |
Sent when the approval state of an entity changed. | State |
Note:
In templates that haveTTL, you can also call FormatTTL to format the TTL as “in XX hours”
The following fields can be used inside all of the email templates:
| Field | Description | Notes |
|---|---|---|
User.ID |
The identifier of the user. | If the recipient is the contact of the target entity, the value will be empty. |
User.Name |
The full name of the user. | If the recipient is the contact of the target entity, the value will be user. |
User.Email |
The email of the user. | None. |
Network.Name |
The full name of the network running on the stack. | None. |
Network.IdentityServerURL |
The base URL of the Identity Server. | None. |
Network.ConsoleURL |
The base URL of the Console. | None. |
Entity.Type |
The type of the target entity, such as application, client, gateway, organization or user. |
None. |
Enitity.ID |
The identifier of the target entity. | None. |
Contact.Type |
The contact type of the recipient, such as technical, billing or abuse. |
Only used if the recipient is the contact of an entity. |