Webhook Events

Learn how you can receive events on your server

You can receive user events on your server, so that you can manually handle registration, email follow-ups, etc.

Receive policy

Maximum response time: 10 sec
Maximum retry count: 30
Retry timeout: exponential backoff

Your server must respond with 2xx status within 10 seconds of request. If your server does not respond, we consider event not being received.

FunnelFox will repeatedly send unreceived events up to 30 times. Every next retry is delayed exponentially using the following formula:

delay ( n ) = n 4 + 15 + rand ( 0 , 29 ) × ( n + 1 )
  • delay is retry delay in seconds
  • n is retry attempt
  • rand(0, 29) is a random amount of seconds from 0 to 29

Events

All events schemas can be found in our API reference.

EventSchemaDescription
onboarding.startedlinkFires when user has opened your onboarding and page has loaded, new session is created.
onboarding.completedlinkFires when user has reached a final screen in onboarding.
profile.updatedlinkFires when user has provided or changed their email (Re-using the same email will not trigger a new event)
purchase.completedlinkFires, when user has completed a purchase or when recurrent/upsell purchase happens
subscription.createdlinkFires, when subscription is created, but was not paid yet
subscription.trialinglinkFires, when subscription activated in
subscription.activelinkFires, when user has paid first payment in subscription. This would be the main indication of active subscription
subscription.cyclelinkFires, when user has paid recurring payment in subscription
subscription.pausedlinkFires, when PSP pauses subscription from billing
subscription.resumedlinkFires, when subscription is resumed after pause
subscription.cancelledlinkFires, when user has cancelled subscription
subscription.unpaidlinkFires, when PSP fails to collect money to renew subscription

🚧

Assign screen with ID final*

We currently consider a “final screen” as a screen with ID that starts the final custom ID. Only these screens will hook onboarding.completed events.