V2
V2 Webhook Events
This page covers the events that the V2 webhooks will send. These will be sent to all companies. If you are an app, head to the V5 events.
- membership.went_valid
- membership.went_invalid
- membership.metadata_updated
- payment.succeeded
- payment.failed
- payment.affiliate_reward_created
membership.went_valid
This webhook will fire when a membership becomes valid, typically when a membership is created or a user checks out.
Business Logic Example: Mark a user’s subscription as valid, which allows them to access a gated section of my app.
Important Attributes: id, valid, status, user.id, product.id
membership.went_invalid
This webhook will fire when a membership becomes invalid, typically when a subscription is canceled or the membership expires.
Business Logic Example: Mark a user’s subscription as invalid, which blocks them from accessing a gated section of my app.
Important Attributes: id, valid, status, user.id, product.id
membership.metadata_updated
This webhook will fire when a membership’s metadata changes.
Business Logic Example: Metadata changes could mean a license key is bound to a user’s machine, or a license key being reset, etc.
Important Attributes: id, valid, status, user.id, product.id, metadata
payment.succeeded
This webhook will fire when a payment is successful, for both new and existing memberships.
Business Logic Example: Update a user’s credit balance with the amount of the payment and send them a receipt via email.
Important Attributes: id, membership, status, final_amount, user.id, product.id
payment.failed
This webhook will fire whenever a payment attempt fails. This is usually due to a card having insufficient funds, or a crypto payment not having a proper allowance or balance.
Business Logic Example: Record the failed payment attempt so that you can remind the user with an overlay inside of your app to have them update their payment method.
Important Attributes: id, membership, status, final_amount, user.id, product.id
payment.affiliate_reward_created
This webhook will fire whenever a user refers someone to your product.
Business Logic Example: Give the referring user extra credits or display an overlay to thank them.
Important Attributes: id, user.id, product.id, affiliate_reward