Configuração de notificação

Aqui demostraremos como você poderá escolher quais tipos de eventos serão notificados e por quais meios a notificação ocorrerá.

Aviso

Caso não exista uma configuração de notificação para um evento, você não receberá notificações do mesmo.

Criação de configuração de notificação

Request

ENDPOINT

/notification/notification_configuration

MÉTODO

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"}

Listando configurações de notificação

Request

ENDPOINT

/notification/notification_configurations

MÉTODO

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
    }
}

Atualização de configuração de notificação

Request

ENDPOINT

/notification/notification_configuration/NOTIFICATION_CONFIGURATION_KEY

MÉTODO

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": {}
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) translation
400	PMB000026	Invalid notification for event type	Invalid notification method for event type	Método de notificação inválido para tipo de evento