For the complete documentation index, see llms.txt. This page is also available as Markdown.

End User Events

End User Events are triggered by certain actions aimed at the End User or elements related to it.

end_user.added – occurs when Company or Organization adds an End User to themselves and the end user confirms registration, not only be invited (Listing 5.8).

Listing 5.8 – Example of end_user.added Payload (JSON)

{
    "type":         "end_user.added",
    "data":         {
        "end_user":     {...//End User Model}
    },
    "created_at":   {...//Date Time Model}
}

end_user.deleted – occurs when Company or Organization deletes their own End User. The end user must be registered, not only invited (Listing 5.9).

Listing 5.9 – Example of end_user.deleted Payload (JSON)

{
    "type":         "end_user.deleted",
    "data":         {
        "end_user":     {...//End User Model}
    },
    "created_at":   {...//Date Time Model}
}

end_user.updated – occurs when certain data is updated in an organization's/company’s End User, such as a name or email, for example (Listing 5.10).

Listing 5.10 – Example of end_user.updated Payload (JSON)

Last updated

Was this helpful?