For the complete documentation index, see llms.txt. This page is also available as Markdown.

Email Configuration and Brevo templates

For successful email sending, we recommend using Brevo for email delivery.

  1. Create a Brevo account.

  2. Generate an API key.

  3. The API key must be inserted into the code by a tokenforge developer.

In the next step, the email templates need to be created.

  1. In Brevo, go to Campaigns -> Templates -> Email Templates.

  2. Create a new template. These are the basic mandatory templates:

    • Account successfully created

    • Wire Transfer - Information

    • Order Confirmation

    • Forgot your password?

    • Payment successful

  3. Remember the ID of the corresponding template.

  1. In the TokenSuite, go to Configuration -> Email Template Assignments.

  2. Enter the appropriate Brevo ID in the corresponding Email Template.

Email templates and variables

Here is a list of all possible email templates that can be set up in Brevo with the possible variables:

Email Template
Possible Variables
Description

user_registration

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }}

Triggered upon registration of a new user.

password_reset

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }} {{ params.RESET_PASSWORD_LINK }}

Triggered upon a password reset request.

reset_password_token

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }} {{ params.RESET_PASSWORD_LINK }}

Triggered upon creation of a reset password token.

verification_token

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.ACCOUNT_ACTIVATION_LINK }} {{ params.EMAIL }}

Triggered upon creation of an account activation token.

account_verification_token

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.ACCOUNT_ACTIVATION_LINK }} {{ params.EMAIL }}

Triggered upon creation of an account activation token.

order_confirmation

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }}

Triggered upon order confirmation.

invoice_generated

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }}

Triggered upon invoice generation.

KYC_PROCESS_BEGIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }} {{ params.KYC_ID }} {{ params.KYC_LINK }}

Triggered upon the beginning of the KYC process.

KYC_STATE_APPROVED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon KYC state approval.

KYC_STATE_APPROVED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon KYC state approval - sent to administrator email address.

KYC_STATE_APPROVED_DATA_CHANGED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon KYC state approval with data change.

KYC_STATE_APPROVED_DATA_CHANGED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon KYC state approval with data change - sent to administrator email address.

KYC_STATE_REJECTED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon KYC state rejection.

KYC_STATE_APPROVED_IN_REVIEW_TO_REJECTED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon KYC state change from approved in review to rejected.

KYC_STATE_APPROVED_IN_REVIEW_TO_REJECTED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon KYC state change from approved in review to rejected - sent to administrator email address.

CUSTOMER_STATUS_APPROVED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer status approval.

CUSTOMER_STATUS_APPROVED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer status approval - sent to administrator email address.

CUSTOMER_STATUS_REJECTED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer status rejection.

CUSTOMER_STATUS_REJECTED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer status rejection - sent to administrator email address.

CUSTOMER_STATUS_FOLLOWED_UP

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer status follow-up.

CUSTOMER_STATUS_FOLLOWED_UP_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer status follow-up - sent to administrator email address.

CUSTOMER_CRYPTO_REGISTRAR_STATUS_APPROVED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer crypto registrar status approval.

CUSTOMER_CRYPTO_REGISTRAR_STATUS_APPROVED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer crypto registrar status approval - sent to administrator email address.

CUSTOMER_CRYPTO_REGISTRAR_STATUS_REJECTED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer crypto registrar status rejection.

CUSTOMER_CRYPTO_REGISTRAR_STATUS_REJECTED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer crypto registrar status rejection - sent to administrator email address.

CUSTOMER_CRYPTO_REGISTRAR_STATUS_FOLLOWED_UP

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer crypto registrar status follow-up.

CUSTOMER_CRYPTO_REGISTRAR_STATUS_FOLLOWED_UP_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon customer crypto registrar status follow-up - sent to administrator email address.

ORDER_LIABILITY_STATUS_APPROVED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order liability status approval.

ORDER_LIABILITY_STATUS_APPROVED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order liability status approval - sent to administrator email address.

ORDER_LIABILITY_STATUS_REJECTED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order liability status rejection.

ORDER_LIABILITY_STATUS_REJECTED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order liability status rejection - sent to administrator email address.

ORDER_LIABILITY_STATUS_FOLLOWED_UP

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order liability status follow-up.

ORDER_LIABILITY_STATUS_FOLLOWED_UP_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order liability status follow-up - sent to administrator email address.

ORDER_CRYPTO_REGISTRAR_STATUS_APPROVED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order crypto registrar status approval.

ORDER_CRYPTO_REGISTRAR_STATUS_APPROVED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order crypto registrar status approval - sent to administrator email address.

ORDER_CRYPTO_REGISTRAR_STATUS_REJECTED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order crypto registrar status rejection.

ORDER_CRYPTO_REGISTRAR_STATUS_REJECTED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order crypto registrar status rejection - sent to administrator email address.

ORDER_CRYPTO_REGISTRAR_STATUS_FOLLOWED_UP

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order crypto registrar status follow-up.

ORDER_CRYPTO_REGISTRAR_STATUS_FOLLOWED_UP_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order crypto registrar status follow-up - sent to administrator email address.

PAYMENT_COMPLETED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon payment completion.

PAYMENT_REFUNDED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon payment refund.

REFUND_REQUESTED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon refund request.

REFUND_REQUESTED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon refund request - sent to administrator email address.

ORDER_COMPLETE_WITH_OFFLINE_PAYMENT

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.AMOUNT_DE }} {{ params.AMOUNT_EN }} {{ params.CURRENCY }} {{ params.PAYMENT_SUBJECT }}

Triggered upon completion of an order with offline payment.

ORDER_COMPLETE_WITH_CRYPTO_PAYMENT

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon completion of an order with crypto payment.

ORDER_COMPLETE_WITH_CRYPTO_PAYMENT_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon completion of an order with crypto payment - sent to administrator email address.

CART_INVESTMENT_INFORMATION

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }}

Triggered upon investment information in the cart.

TANGANY_WALLET_CREATION_ADMIN

{{ params.CUSTOMER_UUID }} {{ params.CUSTOMER_TYPE }} {{ params.CUSTOMER_EMAIL }} {{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.KYC_ID }} {{ params.WALLET_ID }} {{ params.PEP }} {{ params.EMAIL }}

Triggered upon creation of a wallet - sent to administrator email address.

TANGANY_WALLET_CREATION_CUSTOMER

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }}

Triggered upon creation of a wallet by customer.

LISTING_CREATED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }} {{ params.EDITION_NUMBER }} {{ params.BUYBACK_PRICE }} {{ params.LISTING }} {{ params.LISTING_TYPE }} {{ params.BANK_ACCOUNT_HOLDER }} {{ params.BANK_ACCOUNT_IBAN }} {{ params.BANK_ACCOUNT_BIC }} {{ params.BANK_ACCOUNT_BANK_NAME }}

Triggered upon creation of a listing.

LISTING_CREATED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }} {{ params.EDITION_NUMBER }} {{ params.BUYBACK_PRICE }} {{ params.LISTING }} {{ params.LISTING_TYPE }} {{ params.BANK_ACCOUNT_HOLDER }} {{ params.BANK_ACCOUNT_IBAN }} {{ params.BANK_ACCOUNT_BIC }} {{ params.BANK_ACCOUNT_BANK_NAME }}

Triggered upon creation of a listing - sent to administrator email address.

LISTING_APPROVED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }} {{ params.EDITION_NUMBER }} {{ params.BUYBACK_PRICE }} {{ params.LISTING }} {{ params.LISTING_TYPE }} {{ params.BANK_ACCOUNT_HOLDER }} {{ params.BANK_ACCOUNT_IBAN }} {{ params.BANK_ACCOUNT_BIC }} {{ params.BANK_ACCOUNT_BANK_NAME }}

Triggered upon approval of a listing.

LISTING_REJECTED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }} {{ params.EDITION_NUMBER }} {{ params.BUYBACK_PRICE }} {{ params.LISTING }} {{ params.LISTING_TYPE }} {{ params.BANK_ACCOUNT_HOLDER }} {{ params.BANK_ACCOUNT_IBAN }} {{ params.BANK_ACCOUNT_BIC }} {{ params.BANK_ACCOUNT_BANK_NAME }}

Triggered upon rejection of a listing.

LISTING_REDEEM_CREATED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }} {{ params.EDITION_NUMBER }} {{ params.BUYBACK_PRICE }} {{ params.LISTING }} {{ params.LISTING_TYPE }} {{ params.BANK_ACCOUNT_HOLDER }} {{ params.BANK_ACCOUNT_IBAN }} {{ params.BANK_ACCOUNT_BIC }} {{ params.BANK_ACCOUNT_BANK_NAME }}

Triggered upon creation of a redeem listing.

LISTING_REDEEM_CREATED_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }} {{ params.EDITION_NUMBER }} {{ params.BUYBACK_PRICE }} {{ params.LISTING }} {{ params.LISTING_TYPE }} {{ params.BANK_ACCOUNT_HOLDER }} {{ params.BANK_ACCOUNT_IBAN }} {{ params.BANK_ACCOUNT_BIC }} {{ params.BANK_ACCOUNT_BANK_NAME }}

Triggered upon creation of a redeem listing - sent to administrator email address.

LISTING_REDEEM_APPROVED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }} {{ params.EDITION_NUMBER }} {{ params.BUYBACK_PRICE }} {{ params.LISTING }} {{ params.LISTING_TYPE }} {{ params.BANK_ACCOUNT_HOLDER }} {{ params.BANK_ACCOUNT_IBAN }} {{ params.BANK_ACCOUNT_BIC }} {{ params.BANK_ACCOUNT_BANK_NAME }}

Triggered upon approval of a redeem listing.

MINTING_COMPLETE

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon completion of minting process.

ORDER_CONFIRMATION_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.EMAIL }} {{ params.PRODUCT_NAME }}

Triggered upon order confirmation - sent to administrator email address.

TRANSACTION_SYNC_FAILED

{{ params.EMAIL }} {{ params.TRANSACTION_ID }} {{ params.TRANSACTION_HASH }}

Triggered upon transaction synchronization failure.

SYNC_TRANSACTION_MANUALLY

{{ params.EMAIL }} {{ params.TRANSACTION_ID }} {{ params.TRANSACTION_HASH }}

Triggered upon manual synchronization of transaction.

USER_REGISTRATION_ADMIN

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon user registration - sent to administrator email address.

ORDER_COMPLETE_VENDOR

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon order completion by vendor.

PAYMENT_COMPLETED_VENDOR

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.ORDER }} {{ params.ORDER_NUMBER }} {{ params.PRODUCT_NAME }}

Triggered upon payment completion by vendor.

ONBOARDING_DOCUMENTS_SIGNED

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }}

Triggered upon signing of onboarding documents.

REGISTRY_EXCERPT_AVAILABLE

{{ params.FIRST_NAME }} {{ params.LAST_NAME }} {{ params.CUSTOMER_EMAIL }} {{ params.EMAIL }} {{ params.EXCERPTS_LINK }}

Triggered upon availability of registry excerpt.

Last updated