selectRelation

Explanation of the event

The selectRelation event occurs whenever a relation is selected or deselected in MplusKASSA. This can be done through a manual lookup or something like the scan of a card.

selectRelation A relation is selected

request

This event occurs when relation number 1 is selected at workplace 1.1.

Endpoint
POST https://www.example.com/webhooks/selectRelation
Headers
X-Mplus-Subscription-Id: example_subscription
X-Mplus-Signature: ZJABi6vnhFEAFQph9aH29+CvlKnIYoH8vFw/oK8fv5w=
Content-Type: application/json
Accept: application/json
Payload
{
    "event": {
        "eventBlocking": false,
        "eventCounter": 1,
        "eventTimestamp": "2022-07-08T13:37:54.324+02:00"
    },
    "sender": {
        "branchNumber": 1,
        "workplaceNumber": 1
    },
    "session": { ... },
    "selectRelation": {
        "relation": {
            "relationNumber": 1,
            "name": "John Doe"
        }
    }
}
Property Type Explanation
selectRelation.relation object Full details of the selected relation

selectRelation A relation is deselected

request

This event occurs when relation is deselected at workplace 1.1.

Endpoint
POST https://www.example.com/webhooks/selectRelation
Headers
X-Mplus-Subscription-Id: example_subscription
X-Mplus-Signature: ZJABi6vnhFEAFQph9aH29+CvlKnIYoH8vFw/oK8fv5w=
Content-Type: application/json
Accept: application/json
Payload
{
    "event": {
        "eventBlocking": false,
        "eventCounter": 1,
        "eventTimestamp": "2022-07-08T13:37:54.324+02:00"
    },
    "sender": {
        "branchNumber": 1,
        "workplaceNumber": 1
    },
    "session": { ... },
    "selectRelation": null
}
Property Type Explanation
selectRelation.relation object A value of null means there is currently no relation selected