Modify Notification

Example Use Case

Monitoring for potential account takeover by tracking settings changes.

Request Specifications

Required API Field	Definition	Notes
`timestamp`	Timestamp of the event.
One of: `external_entity_id` `entity_token`	Unique identifier for the Entity associated with the modify notification event.
`notification.type`	The type of notification being modified.	Possible enum values: security, general, account, transaction
`notification.subtype`	A more granular description of the notification being modified. This field is required, but free-form.

Example Request/Response

Security Notification Change

{
    "event_type": "modify_notification",
    "event_status": "attempted",
    "event_lifecycle_id": "d5f3a8aa-9da2-4f33-9f8a-b9d5dc29f8a1",
    "data": {
        "timestamp": "2025-10-28T21:32:19.583Z",
        "external_entity_id": "94d57b2e-c516-4240-9fcc-5f96238f8c1e",
        "enabled": false,
        "notification": {
            "type": "security",
            "subtype": "new_device_registered"
        },
        "device": {
            "device_type": "mobile",
            "ip_address_v4": "20.74.92.119"
        },
        "meta": {
            "foo": "bar"
        },
        "supplemental_data": {}
    }
}

{
    "status_code": 201,
    "event_request_token": "EV-PBtvwjn2Dn52slXOkGKH",
    "_links": {
        "self": {
            "href": "/v1/events/EV-PBtvwjn2Dn52slXOkGKH"
        }
    },
    "event": {
        "event_type": "modify_notification",
        "event_status": "PROCESSED",
        "event_lifecycle_id": "d5f3a8aa-9da2-4f33-9f8a-b9d5dc29f8a1",
        "data": {
            "timestamp": "2025-10-28T21:32:19.583Z",
            "external_entity_id": "94d57b2e-c516-4240-9fcc-5f96238f8c1e",
            "enabled": false,
            "notification": {
                "type": "security",
                "subtype": "new_device_registered"
            },
            "device": {
                "device_type": "mobile",
                "ip_address_v4": "20.74.92.119"
            },
            "meta": {
                "foo": "bar"
            },
            "supplemental_data": {},
            "entity_token": "P-9QA3PSY6r2DQb3g3X2Ux"
        },
        "evaluations": [],
        "journey_applications": []
    }
}

Transaction Amount Notification Change

{
    "event_type": "modify_notification",
    "event_status": "attempted",
    "event_lifecycle_id": "79c3e3cb-1e35-47b6-889f-ea61adf3e485",
    "data": {
        "timestamp": "2025-10-28T21:33:40.702Z",
        "external_entity_id": "94d57b2e-c516-4240-9fcc-5f96238f8c1e",
        "enabled": false,
        "notification": {
            "type": "transaction",
            "subtype": "single_transaction_amount"
        },
        "operator": "greater_than",
        "amount": 100000,
        "device": {
            "device_type": "mobile",
            "ip_address_v4": "175.156.22.81"
        },
        "meta": {
            "foo": "bar"
        },
        "supplemental_data": {}
    }
}

{
    "status_code": 201,
    "event_request_token": "EV-ByiqfSNBQqoPrmrf1ynH",
    "_links": {
        "self": {
            "href": "/v1/events/EV-ByiqfSNBQqoPrmrf1ynH"
        }
    },
    "event": {
        "event_type": "modify_notification",
        "event_status": "PROCESSED",
        "event_lifecycle_id": "79c3e3cb-1e35-47b6-889f-ea61adf3e485",
        "data": {
            "timestamp": "2025-10-28T21:33:40.702Z",
            "external_entity_id": "94d57b2e-c516-4240-9fcc-5f96238f8c1e",
            "enabled": false,
            "notification": {
                "type": "transaction",
                "subtype": "single_transaction_amount"
            },
            "operator": "greater_than",
            "amount": 100000,
            "device": {
                "device_type": "mobile",
                "ip_address_v4": "175.156.22.81"
            },
            "meta": {
                "foo": "bar"
            },
            "supplemental_data": {},
            "entity_token": "P-9QA3PSY6r2DQb3g3X2Ux"
        },
        "evaluations": [],
        "journey_applications": []
    }
}