Voucherify distinguishes two types of events - custom and internal. Both are presented in the same Event structure.

Custom Events

Custom Events are actions taken by your customers. They’re best suited for tracking high-value customer interactions with your application. Logging a custom event can trigger any number of distributions, and enables the segmentation filters around the recency and frequency of that event.

With Custom Event metadata field, Voucherify allows you to set properties on custom events. These properties can then be used for further qualifying trigger conditions, increasing personalization in messaging, and generating more sophisticated analytics through raw data export.

The Custom Events are directly linked to the customers' resources from Voucherify. It means that each event gets a connection to a customer.

📘

An example

If an e-commerce application wanted to send a message to a user when he/she abandons their cart, the custom event could additionally improve its target audience and allow for increased distribution personalization by adding a Custom Event of the value of customers’ order.

Internal Voucherify Events

Moreover, Events are our way of letting you know when something interesting happens in your project. When an interesting event occurs, we create a new Event object. For example, when a redemption succeeds, we create a redemption.succeeded event.

Note that many API requests may cause multiple events to be created. For example, if you create a new redemption for a new customer not existing yet in Voucherify, you will receive both a customer.created event and a redemption.succeeded event.

The events occur when the state of another API resource changes and the state of that resource at the time of the change is embedded in the data field of the event.

Webhooks

Voucherify also has a separate system for sending the event objects directly to an endpoint at your end (server). We called that mechanism webhooks. They are managed in your project settings.

"data": {
  "object": {
    "customer": {
      "id": "cust_OtHDKrv5sJrjd8aYBYZ6AOIF",
      "name": "Gustav Purpleson",
      "object": "customer",
      "source_id": "[email protected]",
      "created_at": 1510834859417,
      "updated_at": 1510835106559
    },
    "metadata": {
      "lang": "en",
      "test": true,
      "page": "http://main.io"
    }
  }
}

{
  "id": "event_ehkvgZFgSePlb95SH3JJulkApy9Kg9",
  "object": "event",
  "created_at": "2017-11-16T14:45:34.181Z",
  "type": "redemption.succeeded",
  "data": {
    "object": {
      "id": "r_mist0IpebikTaRdxiOGI2IhL",
      "date": "2017-11-16T14:45:32.733Z",
      "order": {
        "id": "ord_AhDlR13vQE5ino95P2NIABBN",
        "items": [
          {
            "object": "order_item",
            "sku_id": null,
            "quantity": 1,
            "source_id": null,
            "product_id": "iphone8"
          }
        ],
        "amount": 50000,
        "object": "order",
        "status": "CREATED",
        "customer": {
          "id": "cust_fJPsoub5ITJnIEVO3v9whrP9",
          "object": "customer"
        },
        "metadata": null,
        "referrer": null,
        "source_id": null,
        "created_at": "2017-11-16T14:45:32.023Z",
        "updated_at": null,
        "discount_amount": 2000
      },
      "object": "redemption",
      "result": "SUCCESS",
      "voucher": {
        "code": "2017-goX-aH",
        "gift": null,
        "type": "DISCOUNT_VOUCHER",
        "object": "voucher",
        "campaign": "SteffenTest",
        "discount": {
          "type": "AMOUNT",
          "amount_off": 2000
        },
        "is_referral_code": false
      },
      "customer": {
        "id": "cust_fJPsoub5ITJnIEVO3v9whrP9",
        "object": "customer"
      },
      "metadata": {
        "city": "London1"
      },
      "customer_id": "cust_fJPsoub5ITJnIEVO3v9whrP9",
      "tracking_id": "track_3tM7KR57bbeIRtMcvpKYr2aAOrCpYBDZ",
      "related_object_type": "voucher"
    },
    "previous_attributes": {}
  },
  "metadata": {
    "source": "API"
  }
}