Custom events in referral campaigns

Custom Events can be used to monitor your customers’ actions that are not tracked in Voucherify by default. Before using them in your API calls, you need to create them in the Event Schema in Project settings. Logging a custom event can trigger coupon distribution and it can be used as customer segmentation filters based on how often the event occurs or when was the last time it happened.

Go to the Custom Events article to learn more.

Add custom event to Event schema

Firstly, add a definition (name) of the new event.

If you need additional properties to send along with the event request, which will be included in validation, you can build a proper schema definition in the Event schema builder.

Click Add next and define a new property (name, type, optional/required checkbox). 

Defining properties is an optional step. The properties which you add to the schema 
must be passed through API in the metadata object. Remember that in the API request, you need to determine the customer (new referred person) and referral object (with only one mandatory property – referral code). 

Here's a code sample with an example of a POST API request defining a custom event:

{
  "event": "signed_up",
  "customer": {
    "source_id": "[email protected]",
    "email": "[email protected]",
    "name": "Alex Doe",
    "metadata": {
      "VIP": true
    }
  },
  "metadata": {
    "sign_up_date": "2019-01-25T14:30:00.000Z"
  },
  "referral": {
    "code": "NRY-01"
  }
}

Define successful referral with custom event

With the Event Schema defined and added to your API, you can use these custom events as a reward trigger in referral campaigns. Follow the step-by-step guide and launch a referral program based on events defined in your Event Schema.

Custom events ideas

Here are some examples of popular custom events that you can use in your referral program, customer segmentation, or distribution:

• customer_subscribed
• cart_abandoned
• sign_up
• newsletter_subscribe
• ebook_download
• check_in
• check_out
• share_social
• share_email
• join_webinar
• join_event
• like_social
• left_review
• left_comment