Notifications

Notifications

Account related activity is presented as notifications from the API. The notifications are similar to activity feed that a user can consume and dismiss as needed.

The notification object

Each notification instance has the following fields

AttributesTypeDescription
idint

The unique ID of the notification object.

typestring

The type of notification. More details on each type can be found below.

is_dismissableboolean

Whether this notification dismissable by the end-user.

contextjson

Additional context for this notification. More information can be found below.

created_atstring

The timestamp when this instance was created.

updated_atstring

The timestamp when this instance was last updated.

dismissed_atstring

The timestamp of when this notification was dismissed. May be null.

In JSON format

{
    "id": 13,
    "type": "too_much_bandwidth_too_little_proxies",
    "is_dismissable": true,
    "context": {},
    "created_at": "2022-06-14T11:58:10.246406-07:00",
    "updated_at": "2022-06-14T11:58:10.246406-07:00",
    "dismissed_at": null,
}

The too_much_bandwidth_too_little_proxies type

This notification is triggered when a user has too much bandwidth and too little proxies. This notification type does not include a context.