Receive user replies automatically from the onboarding.completed event webhook. This allows you to process user responses in real-time without polling your funnels. For detailed webhook structure, see the API reference.
If you’re not using FunnelFox webhooks yet, learn how to enable them in the webhooks documentation.

​
Configuration

To receive the onboarding.completed event webhook, designate one screen as final by setting your final screen’s ID as final or starting with final_. The webhook is sent when users enter the final screen.

​
Data structure

Replies are provided in JSON format. Each reply is an object inside the replies list with the following entities: Screen information (screen):
  • custom_id - ID of the screen set in the Editor
  • id - FunnelFox ID of the screen
  • index - Index number of the screen
Element information (element):
  • custom_id - ID of the element set in the Visual Editor
  • id - FunnelFox internal ID of the element
  • type - Type of the element (Input, Options, Date Picker)
User response (state):
  • value - Exact reply: chosen option value, typed text, selected date

​
Example response

If a user selects an option with Value czuhQ in an Options element with ID optpic on screen with ID select_pic, the resulting JSON looks like this: 
{
  "screen": {
    "custom_id": "select_pic",
    "id": "ffox_id",
    "index": 0
  },
  "element": {
    "custom_id": "optpic",
    "id": "ffox_id",
    "type": "Options"
  },
  "state": {
    "value": "czuhQ"
  }
}