Skip to main content

Events

Events trigger notifications. By reviewing the event list, you can gain understanding of the types of notifications you can receive and the means through which they are delivered (webhook, email, and SMS).

Events have the attributes allowed_sms, allowed_email, and allowed_callback that indicate the possibility of sending SMS, emails, or callbacks respectively. Additionally, in cases where email and SMS sending is possible, they may contain allowed_custom_vars that indicate the variables that can be replaced in the template using the format [allowed_custom_var], which will be replaced by its corresponding value during delivery.

Events consult​

Request​

ENDPOINT
/notification/event_types
METHOD
GET

Query Params​

FieldTypeDescription
pagenumberPage to be retrieved, default value is 0
page_sizenumberNumber of items to be retrieved, default is 10

Response​

STATUS
200
Response Body: Event types list
{
    "data": [
        {
            "event_type": "incoming_ted",
            "allow_sms": false,
            "allow_email": true,
            "allow_callback": true,
            "allowed_custom_vars": ["total_amount", "target_account_number", "target_document_number"]
        },
        {
            "event_type": "outgoing_ted",
            "allow_sms": true,
            "allow_email": true,
            "allow_callback": false,
            "allowed_custom_vars": null
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": 2,
        "rows_per_page": 2
    }
}