The list of all webhook topics you can subscribe to. You can use webhook subscriptions to receive notifications about specific events in TrueToForm from your account.

Each push notification we send to your webhook endpoint will contain the following header with your webhook_secret key. Contact [email protected] in order to request your webhook_secret. Use this to verify that the messages you are receiving are coming from TrueToForm, otherwise you may be receiving bogus data pushed to your endpoint from anybody.

X-Hook-Secret: <webhook_secret>

Your endpoint should respond back with a successful 2XX status code on each message received from TrueToForm. Any other response code will be considered a webhook error.

List of Topics

Widget event notifications

These events are associated with a session of user interaction with the TrueToForm widget.

• session.started: Triggered when a new widget session begins when new sessionId is created
• session.expired: Triggered when a widget session expires, the sessionId can no longer be used and sharing via the link will not work
• scan.started: Triggered when a user initiates a body scan via the TrueToForm scan app
• scan.uploading: Triggered when a newly created scan begins uploading from the TrueToForm scan app
• avatar.processing: Triggered when a new scan has finished uploading and avatar generation begins
• avatar.ready: Triggered when an avatar is ready and successfully sent via the widget session. This can either be a previously created avatar that the user selected during the widget session, or when avatar generation is complete for a new scan that the user created during the widget session.
• avatar.failed: Triggered if avatar generation fails