Notifications

The event messaging system is a replacement for the outdated inbound sms and delivery report notification system (these old systems are considered obsolete, will not be improved, and are not recommended for use).

The event messaging system allows you to send information about events to URIs (http or email). You can customize the system to send notifications of one event to different URIs. You can also send different events to the same URI.

To configure the notifications, open the settings page (account.lox24.eu -> Settings -> Notifications), click “Create webhook” and enter in the URI field the http address or e-mail where you want to receive notifications. By default, all events will be sent to the specified URI. If you want to be notified only about certain events, check the box next to the events you want to be notified about.

If additional webhooks are required, repeat the instructions above. A maximum of five individual notification settings can be created.

The event information will be transmitted in the JSON object format, which has the same format for all events and differs only in the data of the event itself.

Structure of the event object

Field	Type	Description
id	string (36 chars)	Event ID
api_version	string	Version of the data structure
name	string	Event name, e.g. ‘sms.delivery’
created_at	integer	Unix timestamp when event was created
attempt_total	integer	Total number of attempts (re-tries).
attempt_number	integer	Current number of attempt
data	object	Event’s data (see list of events)
notification_task_id	string (36 chars)	Notification task ID (request identifier)

Event example

{
    "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8",
    "data": {
        "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc",
        "key_id": 8207,
        "dlr_code": 1,
        "status_code": 100,
        "callback_data": "some data from user's request here"
    },
    "name": "sms.delivery",
    "created_at": 1653378603,
    "api_version": "2022-05-25",
    "attempt_number": 1,
    "attempts_total": 4,
    "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641"
}

Event transport types

The notification system can send event information in two ways (transports): HTTPS and E-mail.

HTTP

The json is sent as the body of the http request with the header Content-Type: application/json. The service will continue to attempt to send the request (at increasing time intervals) until it receives a response with a status code >= 200 and < 300 or the number of attempts reaches the value specified in the attempt_number field.

NOTE: The response of your endpoint script is not taken into account therefore you have to monitor your script. In the case of malfunctions there is no notification by us.

E-mail

The json is sent as the email’s body with a single attempt from an email no-reply@lox24.eu.

Service hosts and IP adresses

Alerts are sent from the following hosts 162.55.80.140 and 162.55.80.141. If you use a firewall, don’t forget to whitelist those IP addresses.

Notifications

Notifications

Structure of the event object

Event example

Event transport types

HTTP

E-mail

Service hosts and IP adresses

Events list