InviteReferrals provides a Webhook API which triggers user’s end-point on many events. For instance, if there will be any new enrollment there will be a trigger on users end-point. There are many such events such as:

  • Enrollment
  • Manual Leads
  • Invitation
  • Conversion

Note: You need to set up a webhook every time you create a new campaign. 

To integrate Webhook with every campaign you need to navigate to Campaign>>Edit>>Integrations>>Third_Party_Integrations.

invitereferrals webhook

Webhook lets you configure the basic authentication and headers based on the end-point. You can choose an HTTP request type like Get, Put or Post request either one of them which you like.  

Triggered can be configured for different events. Events are as follows:

1. Enrollment

webhook

 

Step 1: Select the event type as  ‘Enrollment’

Step 2: Enter your Webhook name and the dedicated Webhook URL.

Step 3: Select the request type [get, put, post].

Step 4: If you wish to enter the authentication details such as the username or password you can enter so. 

Step 5: Webhook also allows you to enter the different headers and the API key value.

Step 6: Click Submit.

 

Once you are done with all the steps, your user end will trigger on every new enrollment.

Similarly, for all other such events, you can follow the same steps to get the information regarding the campaign. 

2. Invitation: Whenever your referrer invites their friend via email it will be triggered at your end-point. It provides details of Referrer & Friend (Referee).

3. Manual Lead: If your customer is inviting their friend via manual lead [entering their details manually], that is when your end-point will get triggered and you will get information for the same.

4. Conversion: Your end-point is triggered if there is a successful conversion on the referral. The successful conversion can be different from all. For example, some registration can be a conversion and some might consider a purchase as a conversion. 

 

For instance:

Suppose a business is running a referral program called ‘Refer & Earn.’ The business is rewarding 60 sale points on every purchase. Thus, whenever there will be a conversion (sale) InviteReferrals will send a trigger at your endpoints with all the order details and information about the purchase to your integrated application so that you can make the desired action. You can choose the type of conversion as you like (Sale, Register, Share or App Installation.)