Webhook Setup

To receive real-time updates when a user completes a funnel, you need to subscribe to the new_funnel_submission event using your webhook URL. Once subscribed, Quizify will send a POST request with submission data to your specified endpoint.

Subscribe to Webhook

To subscribe, make a POST request to:

rubyCopyEdithttps://app.quizify.io/api/webhooks/subscribe

Headers:

pgsqlCopyEditAuthorization: Bearer your-access-token
Content-Type: application/json

Request Body:

jsonCopyEdit{
  "event": "new_funnel_submission",
  "funnel_id": "your-funnel-shortcode",
  "hookUrl": "https://yourdomain.com/webhook-endpoint"
}

Field Descriptions:

  • event: The type of event you want to subscribe to. Currently only supports new_funnel_submission

  • funnel_id: The unique shortcode of the funnel you want to track

  • hookUrl: The full HTTPS URL where you want to receive webhook data

Successful Response:

jsonCopyEdit{
  "status": "subscribed",
  "funnel_id": "your-funnel-shortcode",
  "event": "new_funnel_submission",
  "hookUrl": "https://yourdomain.com/webhook-endpoint",
  "subscription_id": "unique-id"
}

Unsubscribe from Webhook

To stop receiving events, send a POST request to:

rubyCopyEdithttps://app.quizify.io/api/webhooks/unsubscribe

Headers:

pgsqlCopyEditAuthorization: Bearer your-access-token
Content-Type: application/json

Request Body:

jsonCopyEdit{
  "hookUrl": "https://yourdomain.com/webhook-endpoint",
  "subscription_url": "unique-subscription-id"
}

Field Descriptions:

  • hookUrl: The same URL you used when subscribing

  • subscription_url: The ID returned in the subscription_id field when you first subscribed

Successful Response:

jsonCopyEdit{
  "status": "unsubscribed",
  "subscription_url": "unique-subscription-id"
}

Important Notes

  • Webhook URLs must be served over HTTPS

  • The webhook server should respond within 5 seconds

  • If your endpoint consistently fails, the webhook may be automatically disabled

  • You can always access past submissions from your Quizify dashboard — webhook deliveries are also saved internally

Next Steps

Continue to the next section to see the Payload Format for the new_funnel_submission event.