Event catalog
Release 3.19.0, 141 event types. The event type is what you subscribe to in a webhook (event_types) and what GET /events returns in type. Internal events never leave the platform: they are not delivered to webhooks and are not listed for any credential. The typed schema of each public event, with data and expanded described field by field, is in the webhooks section of the OpenAPI document of the release.
| Event | Version | Visibility | Resource | Payload keys |
|---|---|---|---|---|
| access_schedule.created | 1 | public | access_schedule | id, product_id |
| access_schedule.deleted | 1 | public | access_schedule | id, product_id |
| access_schedule.updated | 1 | public | access_schedule | id, product_id |
| administrator.created | 1 | internal | administrator | id, role |
| administrator.deleted | 1 | internal | administrator | id, role |
| administrator.permissions_updated | 1 | internal | administrator | id, role |
| administrator.restored | 1 | internal | administrator | id, role |
| administrator.updated | 1 | internal | administrator | id, role |
| api_key.created | 1 | internal | credential | actor_admin_id, actor_key_id, credential_id, environment, request_id |
| api_key.deleted | 1 | internal | credential | actor_admin_id, actor_key_id, credential_id, environment, request_id |
| api_key.revoked | 1 | internal | credential | actor_admin_id, actor_key_id, credential_id, environment, request_id |
| api_key.rotated | 1 | internal | credential | actor_admin_id, actor_key_id, credential_id, environment, request_id |
| api_key.updated | 1 | internal | credential | actor_admin_id, actor_key_id, credential_id, diff, environment, request_id |
| banner.created | 1 | public | banner | id, name, status |
| banner.deleted | 1 | public | banner | id |
| banner.updated | 1 | public | banner | id, name, status |
| certificate.deleted | 1 | public | certificate | id, product_id, user_id |
| certificate.issued | 1 | public | certificate | id, product_id, reissue, supersedes_certificate_id, user_id |
| certificate.revoked | 1 | public | certificate | id, product_id, reason, user_id |
| certificate_template.updated | 1 | public | product | product_id |
| comment.created | 1 | public | comment | id, lesson_id, product_id, user_id |
| comment.deleted | 1 | public | comment | id, product_id |
| comment.reply_created | 1 | public | comment | comment_id |
| comment.updated | 1 | public | comment | id, product_id, status |
| configuration.applied | 1 | internal | plan | operation_id, plan_id, summary |
| custom_code.created | 1 | public | custom_code | id, name |
| custom_code.deleted | 1 | public | custom_code | id |
| custom_code.updated | 1 | public | custom_code | id, name |
| custom_field.created | 1 | public | custom_field | id |
| custom_field.deleted | 1 | public | custom_field | id |
| custom_field.updated | 1 | public | custom_field | id |
| delivery.archived | 1 | public | delivery | id, status |
| delivery.created | 1 | public | delivery | gateway, id, name, status |
| delivery.products_updated | 1 | public | delivery | id |
| delivery.restored | 1 | public | delivery | id, status |
| delivery.rules_updated | 1 | public | delivery | id |
| delivery.tags_updated | 1 | public | delivery | id |
| delivery.updated | 1 | public | delivery | id, name |
| department.created | 1 | public | department | id |
| department.deleted | 1 | public | department | id |
| department.updated | 1 | public | department | id |
| diamond.created | 1 | public | diamond | id, name |
| diamond.deleted | 1 | public | diamond | id |
| diamond.updated | 1 | public | diamond | id, name, status |
| diamond_membership.created | 1 | public | diamond_membership | diamond_id, id, user_id |
| diamond_membership.reprocess_requested | 1 | public | diamond_membership | attempt_id, membership_id, operation_id |
| diamond_membership.run_failed | 1 | public | diamond_membership | diamond_id, error, membership_id, stage |
| diamond_membership.stage_changed | 1 | public | diamond_membership | diamond_id, from, membership_id, reason, to, user_id |
| diamond_trigger.updated | 1 | public | diamond_trigger | diamond_id, enabled, id, stage_id |
| email_bounce.ignored | 1 | public | email_bounce | id |
| email_template.updated | 1 | public | email_template | id |
| enrollment.created | 1 | public | enrollment | delivery_id, id, status, user_id |
| enrollment.restored | 1 | public | enrollment | id |
| enrollment.revoked | 1 | public | enrollment | id, status |
| enrollment.updated | 1 | public | enrollment | id, status |
| event_stream.created | 1 | internal | event_stream | actor_admin_id, actor_key_id, environment, id, request_id |
| event_stream.expired | 1 | internal | event_stream | actor_admin_id, actor_key_id, environment, id, request_id |
| event_stream.revoked | 1 | internal | event_stream | actor_admin_id, actor_key_id, environment, id, request_id |
| exam.created | 1 | public | exam | id, product_id, title |
| exam.deleted | 1 | public | exam | id |
| exam.updated | 1 | public | exam | id, product_id, title |
| exam_attempt.completed | 1 | public | exam_attempt | exam_id, id, passed, product_id, score, user_id |
| exam_attempt.reopened | 1 | public | exam_attempt | exam_id, id, product_id, user_id |
| exam_question.created | 1 | public | exam_question | exam_id, id |
| exam_question.deleted | 1 | public | exam_question | id |
| exam_question.updated | 1 | public | exam_question | exam_id, id |
| exam_result.deleted | 1 | public | exam_attempt | exam_id, id, product_id, user_id |
| export.completed | 1 | public | export | file_id, id, total |
| export.created | 1 | public | export | id, resource |
| export.deleted | 1 | public | export | id |
| export.failed | 1 | public | export | id |
| faq.created | 1 | public | faq | id |
| faq.deleted | 1 | public | faq | id |
| faq.updated | 1 | public | faq | id |
| import.analyzed | 1 | public | import | id, rows |
| import.created | 1 | public | import | id, type |
| import.deleted | 1 | public | import | id |
| import.process_requested | 1 | public | import | attempt_id, import_id, mode, operation_id |
| legal_term.updated | 1 | public | legal_term | id, scope |
| lesson.connected | 1 | public | lesson | id, product_id |
| lesson.content_updated | 1 | public | lesson | id, product_id |
| lesson.created | 1 | public | lesson | id, module_id, name, product_id, status |
| lesson.deleted | 1 | public | lesson | id |
| lesson.disconnected | 1 | public | lesson | id, product_id |
| lesson.published | 1 | public | lesson | id, module_id, name, product_id, status |
| lesson.taxonomy_terms_updated | 1 | public | lesson | id, product_id, term_ids |
| lesson.updated | 1 | public | lesson | id, module_id, name, product_id, status |
| lesson_progress.completed | 1 | public | lesson | lesson_id, product_id, user_id |
| menu_item.created | 1 | public | menu_item | id, name |
| menu_item.deleted | 1 | public | menu_item | id |
| menu_item.updated | 1 | public | menu_item | id, name |
| module.created | 1 | public | module | id, name, product_id, status |
| module.deleted | 1 | public | module | id |
| module.published | 1 | public | module | id, name, product_id, status |
| module.updated | 1 | public | module | id, name, product_id, status |
| operation.completed | 1 | public | operation | id, progress, status, type |
| product.created | 1 | public | product | id, name, showcase_id, status |
| product.deleted | 1 | public | product | id |
| product.published | 1 | public | product | id, name, showcase_id, status |
| product.updated | 1 | public | product | id, name, showcase_id, status |
| product_progress.completed | 1 | public | product | product_id, user_id |
| product_progress.milestone_reached | 1 | public | product | milestones, product_id, user_id |
| product_progress.started | 1 | public | product | product_id, user_id |
| product_progress.updated | 1 | public | product | percent, product_id, user_id |
| progress.adjusted | 1 | public | user | product_id, type, user_id |
| question.created | 1 | public | question | id, lesson_id, product_id, user_id |
| question.deleted | 1 | public | question | id, product_id |
| question.reply_published | 1 | public | question | product_id, question_id, visibility |
| question.updated | 1 | public | question | id, product_id, status |
| release_rule.updated | 1 | public | release_rule | rule_id, schedule_id |
| sales_event.reprocess_requested | 1 | public | sales_event | attempt_id, event_id, operation_id |
| score.adjusted | 1 | public | score | adjustment_id, id, points, product_id, user_id |
| score.created | 1 | public | score | id, origin, points, product_id, user_id |
| score.deleted | 1 | public | score | adjustment_id, exam_id, id, points, product_id, user_id |
| settings.updated | 1 | public | settings | fields, group, id |
| showcase.created | 1 | public | showcase | id, name, parent_id, status |
| showcase.deleted | 1 | public | showcase | id |
| showcase.updated | 1 | public | showcase | id, name, parent_id, status |
| tag.created | 1 | public | tag | id |
| tag.deleted | 1 | public | tag | id |
| tag.updated | 1 | public | tag | id |
| taxonomy.created | 1 | public | taxonomy | id, name, product_id |
| taxonomy.deleted | 1 | public | taxonomy | id |
| taxonomy.updated | 1 | public | taxonomy | id, name, product_id |
| taxonomy_term.created | 1 | public | taxonomy_term | id, name, product_id, taxonomy_id |
| taxonomy_term.deleted | 1 | public | taxonomy_term | id, taxonomy_id |
| taxonomy_term.updated | 1 | public | taxonomy_term | id, name, product_id, taxonomy_id |
| term_acceptance.created | 1 | public | term_acceptance | id, legal_term_id, user_id |
| ticket.closed | 1 | public | ticket | id, status |
| ticket.created | 1 | public | ticket | id, status, user_id |
| ticket.reopened | 1 | public | ticket | id, status |
| ticket.reply_created | 1 | public | ticket | ticket_id |
| ticket.updated | 1 | public | ticket | id, status |
| user.access_updated | 1 | public | user | fields, product_id, user_id |
| user.created | 1 | public | user | id |
| user.custom_field_updated | 1 | public | user | custom_field_id, filled, id |
| user.deleted | 1 | public | user | id |
| user.first_accessed | 1 | public | user | id |
| user.restored | 1 | public | user | id |
| user.tags_updated | 1 | public | user | id, tag_ids |
| user.updated | 1 | public | user | id |