Realtime Integration via Webhooks
You can register any number of webhook callbacks, and when you perform this operation, you'll be able to receive key events about a user's privacy, account, experiment registration, and more.
Why should you use webhooks?
User Consent and GDPR Compliance
As an app developer, it's crucial to comply with GDPR and enable users to control their data. Users can grant or revoke consent, impacting your application. To assist with compliance, we offer webhook updates that notify you when users make changes affecting your app.
Use Cases
User Sign In - Sally signs into your application for the first time and you would like to record this sign in event for MAU and DAU stats. Your application will recieve this event every time the user signs into the application.
Consent Update - Sally consents to
location.readand your application would like to pull the latest location information in the backend. You will recieve a webhook when the user changed their consent.Consent Revoke - You want to know when Sally removes certain consent (or all consent) for your application.
Agreement Sign - You want to know when a user has signed an agreement.
Experiment Join - You setup an experiment and would like to record when a user joins or leaves an experiment.
EKYC Events - You want to know when a user has updated their profile and verified their account with ekyc or if a user has their ekyc status changed.
This list may change in time as we add more types of user events and updates.
Event Types and Schemas
When dealing with your application and users, we allow all applications to subscribe and receive key updates when a user has changed their settings, consent, and privacy.
user.app.consent.update
An event that occurs when a user has changed or modified their consent.
✅
user.app.consent.delete
Removed all app consent.
✅
user.experiment.consent.revoked
Quit/abandoned an experiment.
✅
user.experiment.consent.updated
Joined an experiment (or rejoined)
✅
user.agreement.consent.created
User updated their agreements (tos, privacy, etc)
⛔
user.agreement.consent.deleted
User deleted their agreements (tos, privacy, etc)
⛔
user.ekyc.verified
Occurs when a user has verified their ekyc status.
⛔
user.ekyc.revoked
Occurs when a users ekyc has been revoked or expired.
⛔
user.profile.update
The user has updated their key profile information (avatar, display name, etc)
⛔
You may register your own webhook per application. Each application will receive scoped events based on the organization, and updates. update events are for add/remove to the settings, create is for a brand new registration, and delete is for when the user has entirely revoked consent.
Last updated