Event Reference
Every outbound webhook event, generated from the OpenAPI document and grouped by family.
Every outbound webhook event, generated from the same OpenAPI document as the API reference and grouped by family: when it fires, the signed envelope and its headers, the data payload field by field, named examples, caveats and related events. Each family is one page carrying the shared narrative and the ability a token needs to subscribe an endpoint to its events; a row below opens it at that event.
Core Lifecycle
connector.* events
A project's connectors as they are installed, connected, verified, configured and disconnected: the family every connector answers to. Read the overview.
connector.installedA connector was installed on a project: a pending installation with no credentials yet.connector.connectedThe creator connected an installation with their credentials; the connector can act for the project now.connector.disconnectedAn installation was disconnected: the connector withdrew it, the credentials were wiped, the row stays.connector.status_changedA probe or a verify moved an installation's state: connected, degraded or revoked.connector.settings_updatedA declared setting of an installation changed: which fields, never their values.connector.uninstalledA connector was uninstalled from a project: its grants revoked, its resources detached, the installation row kept, with the counts of what that touched.connector.doctor_completedThe connector doctor ran on an installation and found something different from the previous run.connector.outage_openedA platform refused a project's live installation (token revoked or regenerated, bot deleted) and the connector entered an outage.connector.outage_closedA connector outage ended: the installation answered again, another one took its place, or the creator uninstalled the connector.connector.outage_compensatedA closed connector outage settled: how many members had time banked, how much each received, and how many invites lost during the outage were re-sent.coupon.* events
Coupon code lifecycle and redemption. Read the overview.
coupon.createdA new coupon code was authored in a project.coupon.updatedA coupon's terms changed, with a field-by-field list of what moved.coupon.activatedA coupon was switched on and is being offered at checkout again.coupon.deactivatedA coupon was switched off and stops being offered at checkout.coupon.deletedA coupon was removed, carrying its final snapshot.coupon.redeemedA subscriber's discounted payment settled and the redemption was recorded.coupon.exhaustedThe last remaining use of a capped coupon was taken.pass.* events
Time-limited pass access window lifecycle: opened, closed, cancelled, and what happened to each holder. Read the overview.
pass.window_scheduledA new access window came into existence on a time-limited pass plan.pass.window_openedA time-limited pass access window opened and its holders were admitted.pass.window_closedA time-limited pass access window ended and its holders were removed.pass.window_cancelledA creator cancelled a time-limited pass access window, and its holders were resettled.pass.holder_queuedA pass holder tapped their invite link and their join request is now held.pass.holder_movedA pass holder was moved from a cancelled access window to the next available one on the same plan.pass.holder_missedA window closed and one holder never turned up for it.pass.holder_strandedA pass holder's window was cancelled with no replacement available, so their pass ended and a refund is owed.pass_series.* events
Season-ticket lifecycle: bought, each date completing, dates added or dropped mid-season, and the holders-only presale on the next one. Read the overview.
pass_series.purchasedSomeone bought a season ticket and their whole slate was issued.pass_series.leg_addedAn automatic rule absorbed a newly-scheduled window into a live series.pass_series.leg_completedOne date of a holder's season finished, with their running attendance.pass_series.leg_substitutedA cancelled date in a season was replaced, and one holder was moved to the replacement.pass_series.leg_droppedA cancelled date left a holder's season with no replacement, carrying the pro-rata figure.pass_series.seats_exhaustedA capped season ticket sold its last seat.pass_series.completedA holder reached the last date of their season, with the final attendance tallies.pass_series.presale_openedA finished season's holders were given first refusal on the next one.payment.* events
Payment lifecycle: succeeded, failed, pending, refunded. Read the overview.
payment.succeededA provider confirms a successful charge.payment.failedA provider rejects a charge.payment.pendingA payment is initiated, awaiting provider confirmation.payment.refundedA specific charge is refunded, fully or partially.plan.* events
Fires on every change to a plan's state, pricing or storefront position. Read the overview.
plan.createdA plan is first created on a project.plan.updatedAny mutable plan field changes.plan.activatedInactive plan flipped active.plan.deactivatedActive plan flipped inactive.plan.sold_outA plan hit its sales cap, or a pass series filled its last seat, and Subscriby paused it automatically.plan.order_changedThe creator arranged the order plans appear in on the portal and in the bot, or reset it.plan.deletedPlan soft-deleted (removed from the catalog).plan.sync_completedPlan synced to the payment-provider catalog (Stripe, PayPal, CoinPayments or Razorpay).project.* events
Project lifecycle, resource link / unlink, payment method changes. Read the overview.
project.createdA creator registers a new project.project.updatedAny mutable project field changes.project.archivedCreator archives the project; access is suspended.project.restoredAn archived project is re-activated.project.deletedProject hard-deleted. Final event from that project.project.resource.createdA manual perk is registered under a project.project.resource.linkedA place a creator picked on a connector becomes a resource of a project.project.resource.unlinkedResource disconnected from a project.project.resource.deletedResource soft-deleted from a project.project.resource.updatedA resource's title, description or on/off switch changes, or a recovery moves it onto another place.project.resource.status_changedA channel or group enters or exits a degraded state: banned, deleted, or the bot lost its rights.project.payment_method.updatedA payment gateway's credentials, link state or on/off switch changes.project.payment_method.deletedA payment gateway is removed from a project.subscription.* events
Every transition across the subscription statuses, plus upgrade / downgrade. Read the overview.
subscription.createdNew subscription created via access-code redemption or cardless trial.subscription.activatedA paid subscription is acquired. Fires once, at first activation.subscription.trial_startedTrial-enabled plan starts free window.subscription.trial_convertingTrial about to convert. Fires 24h before `trial_ends_at`.subscription.trial_expiredTrial ended without conversion.subscription.renewedRecurring billing successfully charged the subscriber.subscription.reactivatedCancelled subscription re-activated before `ends_at`.subscription.pausedA member's access was suspended. Billing is unaffected and continues on schedule.subscription.unpausedPaused subscription resumes; resource invite links re-issued.subscription.past_dueBilling fails but grace period is active.subscription.unpaidBilling permanently failed; grace expired.subscription.cancelledCancellation recorded; access continues until `ends_at`.subscription.expired`ends_at` reached; access revoked.subscription.refundedRefund recorded against a subscription.subscription.upgradedSubscriber moved to a higher-priced plan.subscription.downgradedSubscriber moved to a lower-priced plan.Membership
access_code.* events
Access-code batch generation, redemption, and expiry. Read the overview.
access_code.generatedA bulk-generate job completes.access_code.redeemedA code is successfully redeemed by a subscriber.access_code.expiredA code passes its expiry without redemption.broadcast.* events
Message broadcast lifecycle: when a send starts, and what it delivered. Read the overview.
broadcast.queuedA broadcast started sending, carrying the audience it resolved to and how many members it will reach.broadcast.completedA broadcast finished sending, carrying the delivered and failed tallies.creator_task.* events
A hand-arranged perk a subscriber bought becomes a task for the creator, and is done. Read the overview.
creator_task.openedA purchase entitles a subscriber to a manual perk, so the creator has something to do by hand.creator_task.completedThe creator marked a manual perk as handed over; the grant is issued.member.* events
Member (subscriber) lifecycle events. Read the overview.
member.joinedA subscriber joins by redeeming an access code against a paid plan.member.trial_joinedA subscriber joins on a trial via cardless trial or access-code redemption.member.convertedA trial converts to a paying subscription.member.churnedA subscriber's last active subscription lapsed.member.removedA subscriber is soft-deleted manually.member.bannedA creator bans a subscriber.member.unbannedA ban is lifted; the subscriber returns to churned status.member.kickedA subscriber is kicked from the project without a ban.member.resource_addedA subscriber gains access to a specific resource.member.resource_pendingA subscriber is entitled to a resource but has no account on its connector yet, so access waits for them to connect one.member.resource_reissuedA subscriber's access to a resource is being reissued: the old grant is revoked and a fresh one follows.member.access_extendedOutage Compensation banked the length of a connector outage on a member's purchase: one event per member, saying when they feel the extra time.member.resource_removedA subscriber loses access to a specific resource.member.identity_linkedA subscriber connects a platform account to their membership.member.identity_unlinkedA subscriber's connected platform account is disconnected from their membership.support.* events
Member support inbox: conversations opened, replied to, assigned and resolved. Read the overview.
support.conversation.openedA member starts their first support conversation on a channel.support.conversation.assignedA support conversation is handed to a team member, or its assignment cleared.support.conversation.resolvedA support conversation is marked resolved and leaves the open queue.support.conversation.reopenedA resolved support conversation becomes active again.support.conversation.blockedA creator silences a member's support messages.support.conversation.unblockedA creator lets a silenced member's support messages through again.support.message.receivedA member sends a message into a support conversation.support.message.sentA reply to a member is recorded and queued for delivery.support.canned_reply.createdA saved reply is added to a project's support inbox.support.canned_reply.updatedA saved reply's title, body, shortcut or position changes.support.canned_reply.deletedA saved reply is removed from a project's support inbox.support.settings.updatedA project's support inbox settings change.Platform
group.* events
Groups bundle collaborators for access control: a named permission set that several people in a team share, and someone can be in more than one. Read the overview.
group.createdA new team group is created.group.updatedA group is renamed or its permission set replaced.group.members_syncedThe set of people in a group changed, with the deltas.group.deletedA group is deleted; its members lose the permissions it granted.recovery.* events
The Disaster Recovery ledger as it moves: incidents opening and resolving, recoveries starting, finishing, failing and being undone, standbys kept and consumed, channels swapped and accounts relinked. Read the overview.
recovery.incident_openedA health probe found the creator's sign-in account unreachable, a project's bot refused by the platform, or a channel or group gone or no longer administered.recovery.incident_resolvedAn open incident closed: a later probe found the thing healthy again, or a recovery replaced it.recovery.operation_startedA recovery began: run by the creator, by the platform on their behalf, or on demand for a healthy resource.recovery.operation_completedA recovery finished and its changes stand; when it can be undone, the window is open from now.recovery.operation_failedA recovery failed before changing anything; the allowance it spent is given back.recovery.operation_revertedThe creator undid a recovery inside its window: a swapped channel put back, or the previous sign-in account restored.recovery.standby_registeredA spare bot is kept ready for a project, or a spare channel or group is kept ready for one resource.recovery.standby_removedA standby is no longer kept: the creator removed it, registered another in its place, or a recovery consumed it.recovery.installation_failed_overAutomatic failover switched a project onto its standby bot without the creator, because the platform refused the live one: the bot-side twin of `recovery.resource_failed_over`.recovery.resource_failed_overAutomatic failover swapped a banned channel or group for its standby without the creator: the failover you sleep through.recovery.resource_replacedThe creator pointed a resource at a replacement channel or group: in a recovery after a ban, or on demand for a healthy resource.recovery.identity_relinkedThe creator's sign-in account moved to another account on the connector: a newly detected one, or the backup switched in.recovery.readiness_changedA line of the Disaster Recovery readiness checklist changed state, and here is the whole checklist as it stands now.role.* events
Role create, update and delete. Read the overview.
role.createdA new role is created within a team.role.updatedA role's name or abilities change.role.deletedA role is deleted. Only roles no collaborator currently holds can be deleted.team.* events
Team creation, rename, deletion, and membership changes. Read the overview.
team.createdA team is created, including the personal team created alongside a new account.team.updatedA team is renamed.team.deletedA team is deleted; its projects are detached, not deleted.team.member.invitedAn invitation is issued to a new collaborator.team.member.joinedAn invited collaborator accepts and joins.team.member.removedA collaborator is removed from a team by its owner.team.member.role_changedA collaborator's role within a team changes.Billing
billing.* events
The creator's own Subscriby subscription tier: trial conversion, invoices, payment failures, grace periods, lockdowns. Read the overview.
billing.invoice_createdA new invoice is generated for the creator's Subscriby tier.billing.invoice_paidAn invoice is paid in full.billing.invoice_overdueA creator invoice is marked overdue.billing.payment_failedA recurring charge against the creator's payment method fails.billing.trial_endingThe creator's platform trial is about to convert and take its first payment.billing.grace_period_warningThe creator is approaching automatic lockdown for an unpaid invoice.billing.account_lockedThe account hits its past-due lockdown.billing.tier_upgradedThe creator upgrades to a higher Subscriby tier.billing.tier_downgradedThe creator downgrades to a lower Subscriby tier.billing.tier_cancelledThe creator cancels their Subscriby subscription.How is this guide?