Clickstream webhook setup

Clickstream webhook delivery streams real-time click events to any REST API endpoint. Setup is provisioned by Rebrandly and requires you to provide your endpoint details and authentication configuration.

Prerequisites

Clickstream must be enabled on your account.
You need a publicly accessible REST API endpoint that accepts POST or PUT requests.

Setup process

Create an authentication header to authorize the integration.
Provide Rebrandly with the following:
- API endpoint URL
- HTTP method (POST or PUT)
- Authentication header key and value
Wait for confirmation from Rebrandly that the integration is active.
Your endpoint will begin receiving click events.

Click event example

{
  "data": [
    {
      "timestamp": "2019-07-02T14:07:06.981094Z",
      "client": {
        "language": "pt",
        "location": {
          "country": "br"
        },
        "agent": {
          "browser": {
            "name": "facebook-app",
            "version": "227.0.0.43.158"
          },
          "os": {
            "name": "android",
            "version": "android-9.0-pie"
          },
          "device": {
            "name": "smartphone"
          },
          "type": "human"
        },
        "session": {
          "started": "2019-07-02T14:07:06.981094Z",
          "first": true
        }
      },
      "referral": {
        "hostname": "m.facebook.com",
        "protocol": "http",
        "path": "/",
        "origin": {
          "type": "social",
          "name": "facebook"
        }
      },
      "route": {
        "id": "a1ec86bf91bfe763ad02f602259ea0a9",
        "slashtag": "",
        "creator": {
          "id": "wf09bfww4eb9jkw2844555e1ce9af4f2",
          "workspace": {
            "id": "d88bfe5fgd14b2ghb44538b9aekpw89",
            "name": ""
          }
        },
        "domain": {
          "id": "9a5ae320f3e247ef8c9b6061131bb517",
          "raw": ""
        },
        "destination": {
          "raw": "https://www.yourdestination.com/?utm_source=cs_facebook_post&utm_medium=customersuccess",
          "protocol": "https",
          "hostname": "www.yourdestination.com",
          "path": "/",
          "params": {
            "query": {
              "utm_source": ["cs_facebook_post"],
              "utm_medium": ["customersuccess"]
            }
          }
        }
      }
    }
  ],
  "key": "abcxyz123"
}

Updated 1 day ago