GrowSurf Docs
Help CenterSystem StatusContact SupportYour Dashboard →
  • Welcome
  • Getting Started for Web
    • Google Tag Manager
    • Participant Auto Authentication
  • Getting Started for Native Mobile
  • Developer Tools
    • Embeddable Elements
    • JavaScript SDK
      • Tutorials
      • Single Page Applications
      • API Reference
    • REST API
      • Tutorials
      • Objects
      • API Reference
      • API Guidelines
      • API Response Codes
    • Webhooks
      • Securing Your Webhooks (optional)
      • Examples
      • Events Reference
    • Metadata
  • Integrations
    • ActiveCampaign
      • Tutorials
    • Amplitude
    • AWeber
      • Tutorials
    • Brevo (formerly Sendinblue)
      • Tutorials
    • Cal.com
    • Calendly
    • Campaign Monitor
      • Tutorials
    • Chargebee
    • Constant Contact
      • Tutorials
    • ConvertKit
      • Tutorials
    • Customer.io
      • Tutorials
    • Drip
      • Tutorials
    • EmailOctopus
      • Tutorials
    • Fullstory
    • GetResponse
      • Tutorials
    • Google Ads
    • Google Analytics
    • Heap
    • Help Scout
    • HubSpot
      • Tutorials
    • Intercom
      • Tutorials
    • Klaviyo
      • Tutorials
    • LinkedIn Ads
    • Mailchimp
      • Tutorials
    • MailerLite
      • Tutorials
    • Mailjet
      • Tutorials
    • Make
      • Tutorials
    • Marketo
      • Tutorials
    • Meta (Facebook) Ads
    • Mixpanel
    • Pabbly Connect
      • Tutorials
    • PayPal
    • Pendo
    • PostHog
    • Recurly
    • Salesforce
      • Tutorials
    • Segment
    • SendGrid
      • Tutorials
    • Slack
    • Stripe
    • Tango Card
    • Typeform
    • X (Twitter) Ads
    • Zapier
      • Tutorials
      • Using Filters
      • Troubleshooting
Powered by GitBook
On this page
  • Example scenarios
  • Getting started
  • Step 1: Add a webhook URL to your campaign
  • Retry logic
  • Next steps

Was this helpful?

  1. Developer Tools

Webhooks

Webhooks send data to your server when important events occur in your referral campaign. This lets you automatically fulfill rewards or update users in your database.

Last updated 2 months ago

Was this helpful?

Example scenarios

Here are a few scenarios in which you would use webhooks:

  • If you want to have an internal points system for your users, webhooks let you add credits to users in your database every time a referral happens.

  • Every time a new participant joins your referral campaign, webhooks lets you save their unique referral link (and other information) into your database.

Getting started

Step 1: Add a webhook URL to your campaign

  1. Go to the Options step in the Campaign Editor.

  2. In the Set up integrations section, click the Webhooks card. Then enter your webhook endpoint URL.

  3. Publish/save your changes.

Tips:

  • You can test your webhook URL to see if it is set up properly and/or to see the different types of data from each webhook event. Simply click the Test button right next to the webhook URL input field.

  • You can select the specific events to receive within the advanced webhook settings section.

  • A total of 5 webhooks can be added per campaign.

Retry logic

If we are unable to deliver a webhook the first time, GrowSurf will attempt to redeliver your webhooks for several days with an exponential back off. After several days of failed attempts we will mark the webhook as undeliverable and it will no longer be retried.

Next steps

GrowSurf uses a queue system with persistent storage, so if our webhook servers ever experience downtime or become unavailable, webhook events will be retried once the servers are restored. You can always check our for webhook health.

View of implementing webhooks, or view what the request payloads for webhook events look like:

System Status page
Examples
When a new participant is added to the campaign
When the campaign ends
When a participant reaches a reward goal
Webhooks can be configured in the Options step in the Campaign Editor