data for each type. The examples are spread over several lines to make them readable.
The Cimento SDKs have a type for each event’s data: see the payload types in the Go reference, or narrow on event.type in TypeScript.
Campaigns
All three campaign events share the samedata.
Campaigns that Cimento creates to give training after a failed phishing simulation don’t send campaign events. Their assignments still send assignment events.
training.campaign.launched
An admin launched a training campaign. Each employee it assigns also sends a training.assignment.created event.
training.campaign.cancelled
An admin cancelled a training campaign that had been launched.
training.campaign.deleted
An admin deleted a training campaign that had been launched, along with its assignments. Deleting a draft sends nothing.
Deleting a campaign sends this one event. It does not send a
training.assignment.removed event for each person, so treat every assignment with this campaignId as gone.Assignments
An assignment is one employee’s training in one campaign.training.assignment.created
An employee was assigned training.
training.assignment.removed
An employee’s training assignment was removed or replaced.
training.assignment.completed
An employee’s training assignment was completed, by them or by an admin on their behalf.
Policies
training.policy.acknowledged
An employee acknowledged a policy.
Exemptions
An exempt employee is left out of campaigns. All three exemption events share the samedata.
An exemption that simply reaches its end date sends no event. Use
endsAt to know when it runs out. training.exemption.ended is sent only when an admin ends an exemption early.training.exemption.created
An employee was exempted from campaigns. Exempting several employees at once sends one event for each.
training.exemption.updated
An employee’s exemption was changed: its end date, its note, or both. A change to the note alone sends this event with the same data as before.
training.exemption.ended
An admin ended an employee’s exemption. endsAt is the time it was ended.