Company Staff Events

Company Staff Events are triggered by certain actions aimed at the company’s employees (staff).

company.staff.added – occurs when the Company adds a Staff user to itself. The staff user must be registered, not only invited (Listing 5.5).

Listing 5.5 – Example of company.staff.added Payload (JSON)

{
    "type":      "company.staff.added",
    "data":      {
        "user":     {...//User Model}
    },
    "created_at":  {...//Date Time Model}
}

company.staff.deleted – occurs when Company deletes its own Staff user. The user must be registered, not only invited (Listing 5.6).

Listing 5.6 – Example of company.staff.deleted Payload (JSON)

{
    "type":      "company.staff.deleted",
    "data":      {
        "user":     {...//User Model}
    },
    "created_at":  {...//Date Time Model}
}

company.staff.updated – occurs when certain data is updated in an company’s Staff user, such as a name or email, for example (Listing 5.7).

Listing 5.7 – Example of company.staff.updated Payload (JSON)

{
    "type":      "company.staff.updated",
    "data":      {
        "user":     {...//User Model}
    },
    "created_at":  {...//Date Time Model}
}