Notifier Email

Introduction

In this guide, we're going to implement part of the security and visibility of operations in your Main Account or SubAccount.

Email Notification

Do you want to receive notification of your operations in a specific email? You need to activate them. In this topic, you will learn how.

Updating email configuration

By default, the main and most critical notification subscriptions will be activated in the default email created in your Main Account. Here, you can update or add new subscriptions.

HTTP Put Request

https://api.sandbox.avenia.io:10952/v2/notifications/email-config/

Fields

Field	Type	Required	Description
email	string	No	The email to associate with the subscriptions.
subscriptions	array	No	A list of subscriptions you want to register for.

Available Subscriptions

Subscription	Description
TICKET	A ticket event refers to any updates related to a created ticket (money) within your Account. Naturally, it may also involve a subAccount. This event can have multiple statuses, such as TICKET-CREATED, DEPOSIT-PROCESSING, among others.

Sample JSON Body

{
  "email": "i.want.receive.updates.here@provider.com",
  "subscriptions": [
    "TICKET"
  ]
}

cURL Example:

curl -X PUT "https://api.sandbox.avenia.io:10952/v2/notifications/email-config/" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-d '{
  "email": "i.want.receive.updates.here@provider.com",
  "subscriptions": [
      "TICKET"
  ]
}'

That’s it, your new email notification settings have been updated.

Get actual email notification config

Let’s take your current email configuration:

HTTP Get Request

https://api.sandbox.avenia.io:10952/v2/notification/email-config/

cUrl Example

curl -X GET "https://api.sandbox.avenia.io:10952/v2/notification/email-config/" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

JSON Response

{
  "config": {
    "id": "00000000-0000-0000-0000-000000000000",
    "email": "i.want.receive.updates.here@provider.com",
    "subscriptions": [
      "TICKET"
    ],
    "createdAt": "2025-02-07T19:54:17.734848Z",
    "updatedAt": "2025-02-07T19:54:17.734848Z"
  }
}

Now that you have your current configuration in hand, it's easy to know what to add, remove, or change.