Developer Guides

Service Events Registration

Suggest Edits

If a partner wants to take advantage of the service events framework, the events must be registered within the product as documented here.

📘

Code must be unique within a given service.

{
    "entitlements": {
        "data": {
            "serviceEvents": {
                "types": [
                    {
                        "code": "9010",
                        "name": "Request Submitted",
                        "senders": ["lender"],
                        "type": ["automated"]
                    },
                    {
                        "code": "9052",
                        "name": "Order Placed on Hold",
                        "senders": ["partner"],
                        "type": ["automated","manual"]
                    },
                    {
                        "code": "9053",
                        "name": "Order is under review",
                        "senders": ["partner", "lender"],
                        "type": ["automated","manual"]
                    }
                ]
            }
        }
    }
}

List of fields that can be set for each serviceEvent during registration:

Registration ElementsComments
codePartner defined unique identifier of the serviceEvent within the partner product.
namePartner defined user friendly title of the serviceEvent.
sendersPartner defined list that determines who can initiate a service event. Allowed values: lender, partner.
typePartner defined list that determines how this serviceEvent can be sent. Allowed values: automated, manual. Manual should only be specified when the sender = lender. This combination enables the SLP messaging feature

Updated 4 months ago