Outbound Webhook - Use A Webhook To Send User Data Out

A webhook is a way for different applications to talk to each other or send data from one application to another in real-time.

In the case of Referral Factory, you can create an outbound webhook to send the data of your new referred user (or referred lead) to any endpoint – this could be an endpoint your developer creates or an endpoint you create in Zapier,  Airtable, Tray.io, or anywhere else that can receive an incoming webhook. 

Once you have created your webhook endpoint that can receive the data you're trying to send out, then navigate to your campaigns tab in your dashboard and click on the Actions dropdown - choose Webhooks 👇

 

campaigns_webhooks

 

Click on the ‘Go To Outbound Webhook’ button 👇

 

outbound_webhook

 

Follow the step-by-step prompts – start by choosing the event that your Webhook should fire on. 

 

webhooks_send_new_users

 

Next, you will need to enter the endpoint that you created earlier. This must be a URL starting with https. 

 

webhooks

 

In the next step, you can enter an access key if you need it. This is not required. 

 

webhook_access_key

 

You will then choose the request type – in most cases you will choose “Send me POST Request”.

 

webhook_request_type

 

Next, you need to customize the request fields and choose what information you want to send through. Toggle on which request fields you would like to pass on. Remember you need to use the same naming convention as your endpoint in order to catch the data correctly. For example – if you have named the field email_address in Airtable, you need to make sure you name it email_address in your Webhook setup on Referral Factory.

 

 

Once you’ve completed the above steps, make sure you give your Webhook a name that you can easily identify and click ‘Save’.

 

webhook_help_guide

 

Congrats. Your Webhook is now setup 🙌

 

Once you have created your Webhook or Webhooks. You can find them here by navigating to your /campaigns tab, clicking the blue 'Actions' button, and then clicking on Webhooks 👇

 

created_webhooks

 

Here is an example of how the request body is formatted in the request when data is sent to your endpoint. Data is sent via query parameters to your Webhook URL. 

 

referrer_id=261470&referrer_code=zgLAYb&referrer_first_name=Jessica&referrer_email=support%2Bjessica%40referral-factory.com&id=261471&code=zruTPh&first_name=Byron&email=support%2Bbyron%40referral-factory.com&url=https%3A%2F%2Fwebhooks.referral-factory.com%2FzruTPh%2Fjoin&source=Referred&date=2022-06-09&referrals_count=0&campaign_id=4815

 

example_of_webhook_format