Skip to main content

Creating custom webhooks

Subscribing to conversion events by creating custom webhooks

Jonathan Denney avatar
Written by Jonathan Denney
Updated over 10 months ago

By clicking to Settings > Webhooks, you can create and manage custom webhooks that subscribe to conversion events.

Event topics:

By creating a custom webhook, here are the events you can subscribe to:

  • Fields submitted by visitors

  • Automation triggered

  • Contact created or updated

Fields submitted by visitors

Use this to subscribe to ConvertFlow field submissions from visitors, for all campaigns or a selected campaign.

Capture their survey responses, quiz answers, and field submissions, regardless of whether they submit a contact identifier (email/phone).

Automation triggered

Use this to subscribe to ConvertFlow field submissions from visitors who trigger the webhook automations you've added to your conversion elements, like so:

Contact created or updated

Use this to subscribe to ConvertFlow field submissions from contacts, for all campaigns or a selected campaign.

Capture survey responses, quiz answers, and field submissions by contacts who've submitted an identifier (email/phone).

Example event payloads:

Conversion event payload from anonymous visitor:

{
"cta_id": 123, # the campaign ID
"name": "My quiz funnel", # the name of the campaign
"cta_type": "page", # the campaign format
"cta_variant": "a", # the campaign variant
"cta_step": 1, # the campaign funnel step
"event": "CTA Quiz Submitted", # the event name
"visitor_token": "b3cf8529-8943-406f-9c10-d898b10f90a1", # visitor ID
"fields": {
"extra": { # custom field values
"pet_type": "Cat",
"pet_age": "12"
},
"latest_score": "100", # funnel score
"source_url": "https://pages.mydomain.com/my-quiz", # last submission URL
},
"contact": {}, # contact object empty if submitted by anonymous visitor
}

Conversion event payload from identified contact:

{
"cta_id": 1234, # the campaign ID
"name": "My lead gen funnel", # the name of the campaign
"cta_type": "page", # the campaign format
"cta_variant": "a", # the campaign variant
"cta_step": 3, # the campaign funnel step
"event": "CTA Form Submitted", # the event name
"visitor_token": "b3cf8529-8943-406f-9c10-d898b10f90a1", # visitor ID
"fields": { # latest fields submission by contact
"name": "Jared",
"last_name": "Dunn",
"phone": "+5555555555",
"email": "jared.dunn@piedpiper.com",
"extra": { # new custom field values
"team_size": "1-10",
},
"latest_score": "10", # funnel score
"source_url": "https://pages.mydomain.com/my-funnel"
},
"contact": {
"id": 123,
"created_at": "2025-01-28T16:10:16.000Z",
"updated_at": "2025-01-28T16:11:50.226Z",
"website_id": 123,
"visitor_token": "fa59d6dc-f9b8-4c4b-b27d-ac60248bf57c",
"email": "jared.dunn@piedpiper.com",
"name": "Jared",
"last_name": "Dunn",
"phone": "+5555555555",
"city": "Miami",
"company_name": "Pied Piper",
"company_title": "C.O.O",
"url": "piedpiper.com",
"state": "Florida",
"address": "123 Main Street",
"zip_code": "33102",
"country": "United States",
"source_url": "https://pages.mydomain.com/my-funnel",
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "",
"utm_term": "",
"utm_content": "",
"referral_source": "https://google.com",
"first_visit": "https://mydomain.com/blog",
"privacy_consent": "true",
"marketing_consent": "true",
"sms_consent": "",
"ip_address": "0db8:85a3:0000:0000:8a2e:0370",
"latest_score": 10,
"extra": {
"team_size": "1-10",
"revenue": "$1m",
},
"link": "https://app.convertflow.com/websites/123/contacts/123"
}
}

Did this answer your question?