Skip to main content
Os seis tipos — access.granted, access.revoked, access.extended, access.shortened, access.restored e access.moved — têm o mesmo corpo. data.enrollment é a matrícula como está agora; data.change é a mudança que o evento conta, com quem a causou (origin) e a janela que passou a valer. Um aluno que comprou:
O mesmo acesso, revogado por um reembolso dias depois — o reason é o tipo do evento que a plataforma mandou:
Como a ordem de chegada não é garantida, decida pelo data.enrollment.status e pelo occurred_at, não pelo type da última mensagem que chegou. Ver Webhooks de saída.

Uma mudança no acesso de um aluno a uma entrega:

  • access.granted: ganhou acesso (compra, assinatura, concessão, convite, importação, link de cadastro ou entrega gratuita).
  • access.revoked: perdeu (reembolso, cancelamento sem carência, revogação, remoção).
  • access.extended / access.shortened: a data de fim mudou.
  • access.restored: uma revogação foi desfeita.
  • access.moved: a matrícula mudou de turma.
id
string<uuid>
required
type
enum<string>
required

O tipo de uma mensagem entregue — os eventos, mais o webhook.test do botão de teste.

Available options:
student.created,
student.updated,
student.removed,
access.granted,
access.revoked,
access.extended,
access.shortened,
access.restored,
access.moved,
purchase.paid,
purchase.refunded,
subscription.past_due,
subscription.canceled,
lesson.completed,
course.completed,
webhook.test
occurred_at
string<date-time>
required
club_id
string<uuid>
required
data
object
required