Webhooks v2 reference
The bodies Cademí sends to a webhook set to payload version 2, the default.
Every event is a POST with a JSON body: version, event (the event name), event_id and the data in payload. The Diamond funnel events are the exception: they carry the data in data.
| Event | Name | When |
|---|
| Student created | user.created | Sent every time a student is created by a sale, by an import, by the dashboard or by the API. Google sign-in does not fire it. |
| Student created by free access | user.created.free | Sent every time a student is created through a free access flow (free sign-up form or redirect). |
| Access granted | user.access.created | Sent every time a delivery is added to a student by hand, from the dashboard or the API. A delivery granted by a sale fires only delivery.add. |
| Terms accepted | user.term.signed | Sent every time a student accepts the platform terms or a product terms. |
| Event | Name | When |
|---|
| Lesson completed | class.concluded | Sent every time a student completes a lesson. |
| Product started | course.initiated | Sent every time a student starts a product. |
| Product at 50% | course.progress.50 | Sent every time a student crosses 50% progress in a product. |
| Product at 75% | course.progress.75 | Sent every time a student crosses 75% progress in a product. |
| Product at 90% | course.progress.90 | Sent every time a student crosses 90% progress in a product. |
| Product milestone | course.progress | Sent every time a student crosses the 50%, 75% or 90% mark in a product. It is the generic version of the three milestone events. |
| Product completed | course.concluded | Sent every time a student completes every lesson of a product. |
| Progress reached | user.progress | Sent every time the student progress in a product reaches the percentage set in the webhook. Carries progress_percentage. |
| Event | Name | When |
|---|
| Exam passed | exam.approved | Sent every time a student passes an exam. |
| Exam failed | exam.reproved | Sent every time a student fails an exam. |
| Event | Name | When |
|---|
| Certificate issued | certificate.created | Sent every time a certificate is issued to a student, reissues included. |
| Event | Name | When |
|---|
| Delivery added | delivery.add | Sent every time a delivery is added to a student, by hand or by a sale. |