API v2: Safe Notifications 🆕

Data Structures

SafeNotificationUserModel

Attribute	Type	Required	Description
safe_id	string		Read-only. Unique safe identifier.
user_id	string		Read-only. Unique user identifier.
user_name	string		Read-only. Username for notification recipient.
user_domain	string		Read-only. User domain.
user_email	string		Read-only. User email address.
email_notifications	number		Read-only. Email notification count or status.
push_notifications	number		Read-only. Push notification count or status.
roles	object-array		Read-only. User roles related to safe notifications.
role_names	string-array		Read-only. Hidden attribute. Array of role names.
role_ids	string-array		Read-only. Hidden attribute. Array of role identifiers.

Retrieve Available Attributes of the SafeNotificationUsersModel

Request

Method	GET
Path	/api/v2/objspec/safe_notification_user

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.

Get Safe Notification Settings for Users

Request

Method	GET
Path	/api/v2/safe/<safe_id>/notification_user

GET /api/v2/safe/<safe_id>/notification_user

Example Request

curl -s -k -X GET \
  -H 'Authorization: <token>' \
  'https://10.31.135.179/api/v2/safe/2/notification_user'

Response

{
    "result": "success",
    "safe_notification_user": [
        {
            "safe_id": "2",
            "user_id": "user456",
            "user_name": "security.admin",
            "user_domain": "internal.com",
            "user_email": "security.admin@internal.com",
            "email_notifications": 5,
            "push_notifications": 3,
            "roles": [
                {
                    "id": "role789",
                    "name": "Safe Administrator"
                }
            ]
        }
    ]
}