Webhooks v1 reference
The bodies Cademí sends to a webhook set to payload version 1. Version 1 is deprecated and receives fixes only; new webhooks should use version 2.
Every event is a POST with a JSON body: event_id, event_type (the event name, in Portuguese) and the data in event.
| Event | Name | When |
|---|
| Student created | usuario.criado | 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 | usuario.criado.gratis | Sent every time a student is created through a free access flow (free sign-up form or redirect). |
| Access granted | usuario.acesso.adicionado | 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 | termo.assinado | Sent every time a student accepts the platform terms or a product terms. |
| Event | Name | When |
|---|
| Lesson completed | aula.concluida | Sent every time a student completes a lesson. |
| Product started | curso.iniciado | Sent every time a student starts a product. |
| Product at 50% | curso.progresso.50 | Sent every time a student crosses 50% progress in a product. |
| Product at 75% | curso.progresso.75 | Sent every time a student crosses 75% progress in a product. |
| Product at 90% | curso.progresso.90 | Sent every time a student crosses 90% progress in a product. |
| Product milestone | curso.progresso | 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 | curso.concluido | Sent every time a student completes every lesson of a product. |
| Progress reached | usuario.progresso | Sent every time the student progress in a product reaches the percentage set in the webhook. Carries progress_percentage. |
| Event | Name | When |
|---|
| Exam passed | prova.aprovado | Sent every time a student passes an exam. |
| Exam failed | prova.reprovado | Sent every time a student fails an exam. |
| Event | Name | When |
|---|
| Certificate issued | certificado.emitido | Sent every time a certificate is issued to a student, reissues included. |
| Event | Name | When |
|---|
| Delivery added | entrega.adicionada | Sent every time a delivery is added to a student, by hand or by a sale. |