Endpoints

Endpoints can be used as targets in Stream Actions. They include Email Service Providers (ESPs), HTTP and FTP endpoints.

Email Service Providers

See Integrations / Email Service Providers for details.

HTTP Endpoint

On session expiry a Stream Action can call an HTTP endpoint.

A POST request will be made to the configured URL.

• The session (as JSON) will be sent along in the POST body.

• Any Action Data properties will be sent as headers. For example if you define action data with Name "propertyOne" and Value "aValue" the POST request will receive the following header: propertyOne: aValue

• A content-type: application/json header will also be included.

The session JSON received in the body will look similar to this:

{
  "sessionKey": "1cd4c033b8db8d6ebe4fdf9b38efb3a4",
  "campaignKey": "732a41f1eb323e6f1ed3e03efc0fdd8c",
  "accountKey": "d78978e96ac813947382f21ed7324228",
  "campaignDomain": "demo.fanplayr.com",
  "timezoneOffset": "-600",
  "ipAddress": "202.138.73.42",
  "source": "direct",
  "sourceType": "direct",
  "referrer": "https://demo.fanplayr.com/",
  "country": "AU",
  "region": "VIC",
  "city": "Melbourne",
  "userKey": "5.kZUYE1VZPT3ZrHwC46E.1649784289",
  "startTime": "2022-05-11 05:26:21",
  "endTime": "2022-05-11 05:28:55",
  "pages": [
    {
      "visitTime": "2022-05-11 05:26:21",
      "pageType": "home",
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:26:30",
      "pageType": "prod",
      "pageProduct": {
        "id": "PP1",
        "name": "Green Platform Pump",
        "price": 69.95,
        "image": "https://cdn3.volusion.com/zchqu.bdgrd/v/vspfiles/photos/PP1-2T.jpg",
        "url": "https://demo.fanplayr.com/product-p/pp1.htm"
      },
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:26:37",
      "pageType": "cat",
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:26:39",
      "pageType": "prod",
      "pageProduct": {
        "id": "RTB1",
        "name": "Penguin Roll Top Backpack",
        "price": 59.95,
        "image": "https://cdn3.volusion.com/zchqu.bdgrd/v/vspfiles/photos/RTB1-2T.jpg",
        "url": "https://demo.fanplayr.com/product-p/rtb1.htm"
      },
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:26:43",
      "pageType": "prod",
      "pageProduct": {
        "id": "RDB1",
        "name": "Rifiano Duffel Bag",
        "price": 74.95,
        "image": "https://cdn3.volusion.com/zchqu.bdgrd/v/vspfiles/photos/RDB1-2T.jpg",
        "url": "https://demo.fanplayr.com/product-p/rdb1.htm"
      },
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:26:48",
      "pageType": "cart",
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:26:55",
      "pageType": "cart",
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:27:02",
      "pageType": "cart",
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:27:05",
      "pageType": "cart",
      "browserLanguage": "en-US"
    },
    {
      "visitTime": "2022-05-11 05:28:55",
      "pageType": "page",
      "browserLanguage": "en-US"
    }
  ],
  "abandonedCart": {},
  "productsViewed": [
    {
      "id": "RDB1",
      "name": "Rifiano Duffel Bag",
      "qty": 1,
      "price": 74.95,
      "image": "https://cdn3.volusion.com/zchqu.bdgrd/v/vspfiles/photos/RDB1-2T.jpg",
      "url": "https://demo.fanplayr.com/product-p/rdb1.htm"
    },
    {
      "id": "RTB1",
      "name": "Penguin Roll Top Backpack",
      "qty": 1,
      "price": 59.95,
      "image": "https://cdn3.volusion.com/zchqu.bdgrd/v/vspfiles/photos/RTB1-2T.jpg",
      "url": "https://demo.fanplayr.com/product-p/rtb1.htm"
    },
    {
      "id": "PP1",
      "name": "Green Platform Pump",
      "qty": 1,
      "price": 69.95,
      "image": "https://cdn3.volusion.com/zchqu.bdgrd/v/vspfiles/photos/PP1-2T.jpg",
      "url": "https://demo.fanplayr.com/product-p/pp1.htm"
    }
  ]
}

FTP Endpoint

Currently not supported.