Skip to main content

Notification Configuration

Here we will demonstrate how you can choose which types of events will be notified and by which means the notification will occur.

Warning

If there is no notification configuration for an event, you will not receive notifications for it.

Creating a Notification Configuration​

Request​

ENDPOINT
/notification/notification_configuration
METHOD
POST
Request Body
{
    "callback": true,
    "email": true,
    "event_type": "account_transaction",
    "sms": true
}

Response​

STATUS
201
Response Body
{"notification_configuration_key":  "69850ae3-28bc-4779-a871-e73e1e883413"}

Listing Notifications Configurations​

Request​

ENDPOINT
/notification/notification_configurations
METHOD
GET

Response​

STATUS
200
Response Body
{
  "data": [{
    "event_type": "account_request",
    "sms_template": "b35ed5fc-fdda-4618-84e6-b49876dabf23",
    "template_configuration_key": "480521cc-b0c9-4938-bd11-0000be11c66b"
  }],
  "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 1
    }
}

Update Notifications configuration​

Request​

ENDPOINT
/notification/notification_configuration/NOTIFICATION_CONFIGURATION_KEY
METHOD
PUT
Request Body
{
    "callback": true,
    "email": true,
    "event_type": "account_transaction",
    "sms": false
}

Response​

STATUS
200
Response Body
{}
STATUS
4XX
Response Body: Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
HTTP CodeQI Code
code		Title
title		Description (eng)
Description		Description (ptbr)
translation
400PMB000026Invalid notification for event typeInvalid notification method for event typeMétodo de notificação inválido para tipo de evento