Skip to main content

Sift Integration Guide

info

To learn more about Sift, check out sift.com

Enabling Sift​

Choose a Sift Model​

You can choose to connect Dodgeball to your own Sift Account, or connect to a pre-configured Sift model optimized for one of the following industries:

  • Digital Goods
  • Travel & Ticketing
  • Food Delivery
  • Internet Gaming
  • E-Commerce
  • Marketplaces

Enable the Sift in the Service Catalog​

  1. From the Service Catalog, click on the View All Services button.
  2. Click on the service for your chosen Sift model. A few examples are shown below:

If you are connecting to your own Sift Account​

  1. Select the Sift service.
  2. Complete the configuration section, including the API Key, Account ID, Beacon Key, and whether you want to enable Browser Tracking.
  3. Click Enable to save your configuration.

If you are connecting to a pre-configured Sift model​

  1. Select the service for your chosen Sift model (e.g. Sift Cohort: E-Commerce).
  2. Click Enable to save your configuration.

Note that EasyBill will charge your account in credits when you use certain Sift functionality. See the Credit Cost Summary for more information.

Using Sift in a Checkpoint​

  1. From the Step Palette click on the Services tab. You will find available step templates here. Click and drap them into the checkpoint flow diagram to add them to your workflow.
  2. Connect the step into the diagram where you want it to run.
  3. Click on the Step to view details about the step, and configure how it runs in the flyout configuration panel.

Optimizing your event data​

Sift uses a variety of data points to make decisions. To get the most out of Sift, you should send as much relevant data as possible. Below are some examples of requests generated with mock data show different ways of sending data to Sift.

info

You can view detailed descriptions of input fields in the Checkpoint studio. It is important to send data that meets the specifications for each field.

Send Event: Create Order (Min Data)​

This is the minimum data you can send to Sift to create an order. We strongly recommend sending more data than this to get the best results from Sift, but this will not cause an error.

{
  "transaction": {
    "externalId": "5bed8ef2-7ff4-4823-afab-9f4f35c1d9d3",
  },
}

Send Event: Create Order (Critical Data)​

This is the most critical data you can send to Sift to create an order. Note that some data may not be relevant to your business, and you may not have it available to send. For example, if a user is not creating an order involving cryptocurrency, you would not send information in the digitalOrders array.

{
  "customer": {
    "externalId": "c073a052-81c8-4409-bae2-16b5b81214bd",
    "primaryEmail": "Jamaal11@hotmail.com",
  },
  "transaction": {
    "externalId": "5bed8ef2-7ff4-4823-afab-9f4f35c1d9d3",
    "currency": "TRY",
    "amount": 646836,
    "billingAddress": {
      "firstName": "Mervin",
      "lastName": "Durgan",
      "phone": "+44 820-916-4833",
      "line1": "10546 Huels Walks",
      "line2": "Suite 714",
      "city": "North Griffin",
      "state": "Missouri",
      "postalCode": "52692",
      "country": "NE"
    },
    "lineItems": [
      {
        "externalId": "cd632348-d88d-466a-b720-d259427b6d15",
        "unitAmount": 8511,
      },
    ]
  },
  "paymentMethod": {
    "externalId": "dfc78bab-dcfe-47c3-8ada-e63028a6b21a",
    "type": "CARD_PREPAID",
    "gateway": "SPREEDLY",
    "cardLastFour": 3333,
    "cardBin": "424242",
    "cardHolderName": "Mervin Durgan"
  },
  "siftSendEventCreateOrder": {
    "inputs": {
      "brandName": "Example Brand",
      "digitalOrders": [
        {
          "externalId": "e6c05dc8-3144-4b2c-932c-1de82e85f401",
          "asset": "BTC",
          "assetPair": "USD_BTC",
          "assetType": "$coin",
          "orderType": "$market",
          "volume": "0.01"
        },
      ]
    }
  }
}

Send Event: Create Order (Max Data)​

This example includes all supported data points for the Create Order event.

{
  "customer": {
    "externalId": "c073a052-81c8-4409-bae2-16b5b81214bd",
    "primaryEmail": "Jamaal11@hotmail.com",
    "primaryPhone": "+44 820-916-4833"
  },
  "transaction": {
    "externalId": "5bed8ef2-7ff4-4823-afab-9f4f35c1d9d3",
    "currency": "TRY",
    "amount": 646836,
    "paymentMethods": [
      {
        "externalId": "659512fb-96e8-4a8f-8a01-6a145983de10",
        "type": "CARD_CREDIT",
        "gateway": "STRIPE",
        "cardLastFour": 1111,
        "cardBin": "424242",
        "cardHolderName": "Mervin Durgan"
      },
      {
        "externalId": "7415f078-4bf5-46dc-9849-ee47267908fa",
        "type": "CARD_DEBIT",
        "gateway": "STRIPE",
        "cardLastFour": 2222,
        "cardBin": "424242",
        "cardHolderName": "Mervin Durgan"
      }
    ],
    "billingAddress": {
      "firstName": "Mervin",
      "lastName": "Durgan",
      "phone": "+44 820-916-4833",
      "line1": "10546 Huels Walks",
      "line2": "Suite 714",
      "city": "North Griffin",
      "state": "Missouri",
      "postalCode": "52692",
      "country": "NE"
    },
    "shipments": [
      {
        "carrier": "USPS",
        "method": "Ground",
        "trackingNumbers": "1234567890, 0987654321",
        "isExpedited": false,
        "isDigitalDelivery": false,
        "address": {
          "firstName": "Mervin",
          "lastName": "Durgan",
          "phone": "+44 820-916-4833",
          "line1": "10546 Huels Walks",
          "line2": "Suite 714",
          "city": "North Griffin",
          "state": "Missouri",
          "postalCode": "52692",
          "country": "NE"
        }
      }
    ],
    "lineItems": [
      {
        "externalId": "cd632348-d88d-466a-b720-d259427b6d15",
        "unitAmount": 8511,
        "numUnits": 76,
        "product": {
          "externalId": "31b1b812-1651-4a99-bc13-8207dea61214",
          "sku": "Chair",
          "upc": "156627478961",
          "name": "Incredible Cotton Pants",
          "category": "Beauty",
          "brand": "Test Brand",
          "manufacturer": "Test Manufacturer",
          "color": "Test Color",
          "size": "Test Size"
        }
      },
      {
        "externalId": "6a8b47e5-6b1a-41e8-b399-c1c443b961fc",
        "unitAmount": 0,
        "numUnits": 0,
        "product": {
          "externalId": "ce1feabc-1c96-4f1e-95d1-2b04398d99ff",
          "sku": "Mouse",
          "upc": "515084550622",
          "name": "Intelligent Granite Chicken",
          "category": "Automotive",
          "brand": "Test Brand",
          "manufacturer": "Test Manufacturer",
          "color": "Test Color",
          "size": "Test Size"
        }
      }
    ]
  },
  "paymentMethod": {
    "externalId": "dfc78bab-dcfe-47c3-8ada-e63028a6b21a",
    "type": "CARD_PREPAID",
    "gateway": "SPREEDLY",
    "cardLastFour": 3333,
    "cardBin": "424242",
    "cardHolderName": "Mervin Durgan"
  },
  "siftSendEventCreateOrder": {
    "inputs": {
      "brandName": "Example Brand",
      "siteDomain": "https://www.example.com",
      "siteCountry": "US",
      "sellerExternalId": "fake-seller-id",
      "digitalOrders": [
        {
          "externalId": "e6c05dc8-3144-4b2c-932c-1de82e85f401",
          "asset": "BTC",
          "assetPair": "USD_BTC",
          "assetType": "$coin",
          "orderType": "$market",
          "volume": "0.01"
        },
        {
          "externalId": "24aae8f9-363c-4773-90cf-ecfd377cc26d",
          "asset": "ETH",
          "assetPair": "USD_ETH",
          "assetType": "$coin",
          "orderType": "$market",
          "volume": "0.02"
        }
      ]
    }
  }
}