Server-to-Server Event

Headers

Accept-Language

string

You can specify the language to use for API requests and result returns. It follows the ISO-639-1 format.

Content-Type

string

Represents the media type of the resource. Defaults to application/json.

Authorization

string

The key value to use for API requests. You can get it by checking out .

X-Forwarded-For

Requiredstring

You can send the user's IP in the X-Forwarded-For header. Without X-Forwarded-For, user behavior is logged with the IP of the server that requested the Server To Server API, not the user's IP (client request IP).

We accept values in the form of ipv4 (123.123.123.123), ipv6 (2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d).

Path Params

app_name

Requiredstring

Airbridge App Name. (Unique ID)

Body Params

eventUUID

string

Random UUID v4 string.

Accepts a random string in UUID4 format.

The event uuid is used for duplication as a unique ID for the event, and will be generated automatically by the event api if not provided.

eventTimestamp

number

The time the event occurred.

A Unix timestamp in milliseconds (13 digits in Unixtime).

If the eventTimestamp is older than 24 hours from the time the event was sent, it will not be processed by the server. Please use a timestamp within 24 hours from the time it was sent.

user

object

User information.

device

object

Device Information.

device.deviceUUID

stringnullable

Airbridge Device ID.

Accepts GAID, IDFA, IDFV, Randomly Generated UUID, or AppSetId.

device.gaid

stringnullable

Advertising ID provided by Google

device.ifa

stringnullable

Advertising ID provided by Apple

device.appSetID

stringnullable

AppSetId provided by Google.

device.ifv

stringnullable

Device ID provided by Apple

device.limitAdTracking

boolean

The device's ad tracking restriction setting.

true for limit ad tracking, false for allow ad tracking. Android iOS

device.deviceModel

stringnullable

Device model name Android iOS

device.appTrackingTransparency

integer

Device locale Android iOS

device.deviceIdentifier

string

A specific device identifier, such as iPhone11,2 (iPhone only).

device.manufacturer

string

Device manufacturer Android iOS

device.osName

Requiredenum

Device OS name. (e.g. "Android", "iOS") (Case sensitive)

ENUM VALUES

Android

Android OS

iOS

iOS

device.osVersion

Requiredstring

Device OS version Android iOS

device.locale

string

Device locale Android iOS

device.timezone

string

Device timezone Android iOS

device.orientation

string

Device orientation Android iOS

device.screen

string

Device screen information.

device.location

object

Device location.

device.network

object

Device network information.

device.alias

object

You can share the user consent necessary to comply with the Digital Markets Act (DMA) with Airbridge. For detailed information about the DMA, refer to this article.

app

Requiredobject

User app information.

eventData

Requiredobject

Event information.

Request

123456
curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/mobile-app/9360' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -H 'X-Forwarded-For: 2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d' \
  -d '{"eventUUID":"9b4b3e4e-2162-4ae6-8986-91ee84644262","user":{"externalUserID":"19443","externalUserEmail":"example@ab180.co","externalUserPhone":"821012341234"},"device":{"deviceUUID":"2dfca632-86f3-4d22-9746-cdfe7985c471","gaid":"2dfca632-86f3-4d22-9746-cdfe7985c471","ifa":"542177F1-5C23-438B-8088-82D34C94F6D7","appSetID":"7c4681ef-97c6-4ebd-9c04-e22f584b3746","ifv":"37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F","deviceModel":"LG-H542","appTrackingTransparency":0,"deviceIdentifier":"iPhone11,2","manufacturer":"Samsung","osName":"Android","osVersion":"5.0.2","locale":"ko-KR","timezone":"Asia/Seoul","orientation":"portrait","screen":{"width":123},"location":{"latitude":120.103,"speed":"12"},"network":{"carrier":"SKTelecom","cellular":true,"wifi":true}},"app":{"packageName":"com.ab180.co","version":"1.2.3"},"eventData":{"goal":{"category":"airbridge.ecommerce.product.addedToCart","action":"shoes","label":"nike","semanticAttributes":{"productListID":"list-id-1","cartID":"cart-id-1","transactionID":"12939172","inAppPurchased":true,"currency":"KRW","products":[{"position":"1","productID":"30372425","name":"나이키 커스텀"}]}}}}'

Payload

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
{
  "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262",
  "user": {
    "externalUserID": "19443",
    "externalUserEmail": "example@ab180.co",
    "externalUserPhone": "821012341234"
  },
  "device": {
    "deviceUUID": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "gaid": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "ifa": "542177F1-5C23-438B-8088-82D34C94F6D7",
    "appSetID": "7c4681ef-97c6-4ebd-9c04-e22f584b3746",
    "ifv": "37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F",
    "deviceModel": "LG-H542",
    "appTrackingTransparency": 0,
    "deviceIdentifier": "iPhone11,2",
    "manufacturer": "Samsung",
    "osName": "Android",
    "osVersion": "5.0.2",
    "locale": "ko-KR",
    "timezone": "Asia/Seoul",
    "orientation": "portrait",
    "screen": {
      "width": 123
    },
    "location": {
      "latitude": 120.103,
      "speed": "12"
    },
    "network": {
      "carrier": "SKTelecom",
      "cellular": true,
      "wifi": true
    }
  },
  "app": {
    "packageName": "com.ab180.co",
    "version": "1.2.3"
  },
  "eventData": {
    "goal": {
      "category": "airbridge.ecommerce.product.addedToCart",
      "action": "shoes",
      "label": "nike",
      "semanticAttributes": {
        "productListID": "list-id-1",
        "cartID": "cart-id-1",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "currency": "KRW",
        "products": [
          {
            "position": "1",
            "productID": "30372425",
            "name": "나이키 커스텀"
          }
        ]
      }
    }
  }
}

Parameter	Description
eventData.shortID	Attribution campaign parameter ID
eventData.trackingData.channel	Attribution campaign parameter channel
eventData.trackingData.params	Attribution campaign parameter

Parameter

Description

eventData.shortID

Attribution campaign parameter ID

eventData.trackingData.channel

Attribution campaign parameter channel

eventData.trackingData.params

Attribution campaign parameter

Headers

Accept-Language

string

You can specify the language to use for API requests and result returns. It follows the ISO-639-1 format.

Content-Type

string

Represents the media type of the resource. Defaults to application/json.

Authorization

string

The key value to use for API requests. You can get it by checking out .

X-Forwarded-For

Requiredstring

We accept values in the form of ipv4 (123.123.123.123), ipv6 (2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d).

Path Params

app_name

Requiredstring

Airbridge App Name. (Unique ID)

Body Params

eventUUID

string

Random UUID v4 string.

Accepts a random string in UUID4 format.

The event uuid is used for duplication as a unique ID for the event, and will be generated automatically by the event api if not provided.

eventTimestamp

number

The time the event occurred.

A Unix timestamp in milliseconds (13 digits in Unixtime).

If the eventTimestamp is older than 24 hours from the time the event was sent, it will not be processed by the server. Please use a timestamp within 24 hours from the time it was sent.

user

object

User information.

browser

object

Browser Information.

eventData

Requiredobject

Event information.

curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/web/9320' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \ -H 'X-Forwarded-For: 2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d' \ -d '{"eventUUID":"9b4b3e4e-2162-4ae6-8986-91ee84644262","user":{"externalUserID":"19443","externalUserEmail":"example@ab180.co","externalUserPhone":"821012341234"},"browser":{"clientID":"05609013-bb5a-4594-bbc3-832cb1b87072","userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302"},"eventData":{"shortID":"aef04","trackingData":{"channel":"blog"},"goal":{"category":"airbridge.ecommerce.product.addedToCart","action":"shoes","label":"nike","semanticAttributes":{"query":"나이키","productListID":"list-id-1","cartID":"cart-id-1","transactionID":"12939172","inAppPurchased":true,"currency":"KRW","products":[{"position":"1","productID":"30372425","name":"나이키 커스텀","price":1000,"quantity":"1","currency":"KRW"}]}}}}'

{ "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262", "user": { "externalUserID": "19443", "externalUserEmail": "example@ab180.co", "externalUserPhone": "821012341234" }, "browser": { "clientID": "05609013-bb5a-4594-bbc3-832cb1b87072", "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302" }, "eventData": { "shortID": "aef04", "trackingData": { "channel": "blog" }, "goal": { "category": "airbridge.ecommerce.product.addedToCart", "action": "shoes", "label": "nike", "semanticAttributes": { "query": "나이키", "productListID": "list-id-1", "cartID": "cart-id-1", "transactionID": "12939172", "inAppPurchased": true, "currency": "KRW", "products": [ { "position": "1", "productID": "30372425", "name": "나이키 커스텀", "price": 1000, "quantity": "1", "currency": "KRW" } ] } } } }

Send In-app Events

Delivery Methods

1. Sending events based on device ID (device.deviceUUID).

2. Sending events based on User ID (user.externalUserID).

Request

Headers

Path Params

Body Params

Response

200SUCCESS

Send In-web Events

Delivery Methods

2. Sending events based on User ID (user.externalUserID).

Request

Headers

Path Params

Body Params

Response

200SUCCESS

Server-to-Server Eventself.__wrap_n!=1&&self.__wrap_b(":R29jtt7ppjtsba:",0.5)

Send In-app Events

Delivery Methods

1. Sending events based on device ID (device.deviceUUID).

2. Sending events based on User ID (user.externalUserID).

Request

Headers

Path Params

Body Params

Response

200SUCCESS

Send In-web Events

Delivery Methods

1. Sending events based on Cookie ID (browser.clientID).

2. Sending events based on User ID (user.externalUserID).

Request

Headers

Path Params

Body Params

Response

200SUCCESS

Server-to-Server Event