Company Events

Company Events are triggered by certain actions aimed at the company or elements related to it.

company.added – occurs when an Organization adds a company to itself and its owner completes registration, not only invited (Listing 5.2).

Listing 5.2 – Example of company.added payload (JSON)

// Some code

company.deleted – occurs when the Organization deletes its own company. The company must be confirmed and has a confirmed owner, not only invited (Listing 5.3).

Listing 5.3 – Example of company.deleted Payload (JSON)

{
    "type":        "company.added",
    "data":        {
        "company":     {...//Account Model}
    },
    "created_at":  {...//Date Time Model}
}

company.updated – occurs when certain data is updated in an organization's Company, such as a name or currency, for example (Listing 5.4).

Listing 5.4 – Example of company.updated Payload (JSON)

{
    "type":        "company.updated",
    "data":        {
        "company":     {...//Account Model}
    },
    "created_at":  {...//Date Time Model}
}