Документация LMS версия 0.1.0

Документация/Проект API/Каталог событий

Это проектная спецификация, а не работающее API: реализации ещё нет, адреса могут измениться.

Собрано из кода — руками не правится · источник: openapi.draft.json (x-lms-events)

Каталог событий

Событий: 82 в 9 группах.

Один справочник на три применения: событие приходит в вебхук, запускает сценарий и лежит в журнале /v1/events. Не три списка, которые разойдутся, а один.

Подписаться можно на группу маской — order.*, submission.* — или на всё сразу: *.

Пользователи #

  • user.created
  • user.updated
  • user.deleted
  • user.anonymized
  • user.tagged
  • user.untagged
  • user.role_granted
  • user.role_revoked
  • user.entered_segment
  • user.left_segment
  • user.consent_given
  • user.consent_revoked
  • user.identity_linked

Группы #

  • group.member_added
  • group.member_removed

Обучение #

  • enrollment.created
  • enrollment.expired
  • enrollment.revoked
  • enrollment.frozen
  • enrollment.curator_changed
  • lesson.opened
  • lesson.completed
  • video.progress
  • video.completed
  • course.completed
  • assignment.deadline_approaching
  • submission.created
  • submission.accepted
  • submission.rejected
  • submission.commented
  • quiz.attempted
  • quiz.passed
  • quiz.failed
  • certificate.issued

Коммерция #

  • order.created
  • order.updated
  • order.paid
  • order.partially_paid
  • order.cancelled
  • order.item_added
  • payment.created
  • payment.succeeded
  • payment.failed
  • payment.refunded
  • receipt.fiscalized
  • receipt.failed
  • purchase.granted
  • purchase.revoked
  • purchase.expiring_soon
  • purchase.expired
  • subscription.created
  • subscription.charged
  • subscription.payment_failed
  • subscription.cancelled
  • promo.redeemed

Сообщения #

  • message.queued
  • message.sent
  • message.delivered
  • message.opened
  • message.clicked
  • message.bounced
  • message.complained
  • message.opted_out
  • campaign.started
  • campaign.finished

Сценарии #

  • scenario.run_started
  • scenario.run_completed
  • scenario.run_failed
  • scenario.node_executed

Вебинары #

  • webinar.registered
  • webinar.session_started
  • webinar.attended
  • webinar.left
  • webinar.offer_clicked
  • webinar.session_finished
  • webinar.comment_created

Сайт #

  • form.submitted
  • page.visited

Служебное #

  • webhook.delivery_failed
  • import.completed
  • export.completed
  • license.check_failed

Чего здесь ещё нет #

Состава поля data.object у каждого события. Форма конверта описана в разделе Вебхуки и она общая для всех событий — это главное. А что именно лежит внутри object для order.paid и чем оно отличается от submission.created, сказать пока нельзя: событий в коде нет, перечень собран разбором проектной спецификации.

Эта страница в Markdown