1. Home
2. /Developer
3. /REST APIs
4. /Real-Time Data Streaming API

Libraries

Airship maintains open source server libraries to support your integrations with our APIs in multiple languages. Click below for library documentation.

• Python
• Java
• Node
• OpenAPI Spec

Introduction

Airship’s Real-Time Data Streaming API exposes a stream of events describing a user’s experience within a mobile app or browser. Events reflect user action, automated device responses to their environment (e.g., encountering a beacon), and experience-changing actions initiated by app/site publishers, such as sending a push notification.

To consume the event stream, you must issue an authenticated request including a starting point for the stream and optional filter and subset specifications.

The event data is delivered as newline-delimited JSON , with each event on its own line. The accept header should be set to application/vnd.urbanairship+x-ndjson; version=3;. Each event contains an offset that denotes its location on the stream. If a client disconnects for any reason, it should reconnect with instructions to start at the last offset it successfully processed, to avoid missing any data. For each app key authorized to use Real-Time Data Streaming, Airship stores 7 days or 100 GB worth of data, whichever comes first.

Base URL

Select the domain associated with your Airship project.

• https://connect.urbanairship.com - The North American base URL for Airship's Real-Time Data Streaming API
• https://connect.asnapieu.com - The European base URL for Airship's Real-Time Data Streaming API

Authentication

For additional information, including steps for creating bearer tokens and OAuth client credentials, see Airship API Security. See also the Airship API Authorization Reference.

• Basic Auth (Master) HTTP (basic)
  Authorization header containing the word Basic followed by a space and a Base64-encoded string generated from your App Key and Master Secret in appKey:masterSecret format. For example, Basic YXBwX2tleTptYXN0ZXJfc2VjcmV0. This security type is only accepted by the Compliance endpoint.
• Bearer Token HTTP (bearer)
  Authorization header containing the word Bearer followed by a space and a bearer token, which can be obtained from Airship when configuring a direct integration. Tokens can be revoked at will.

Event Stream

Opens an event stream to your filter specifications.

Open an event stream

POST /api/events

POST /api/events HTTP/1.1
Authorization: Bearer <authorization token>
X-UA-Appkey: <appkey>
Accept: application/vnd.urbanairship+x-ndjson; version=3;
Content-Type: application/json

{
    "filters": [
        {
            "device_types": [
                "android",
                "amazon"
            ],
            "devices": [
                {
                    "channel": "5b389366-7caf-43e2-a19c-6159c7ea9936"
                },
                {
                    "channel": "c8044c8a-d5fa-4e58-91d4-54d0f70b7409"
                },
                {
                    "named_user_id": "George"
                }
            ],
            "latency": 20000000
        },
        {
            "notifications": [
                {
                    "group_id": "a30abf06-7878-4096-9535-b50ac0ad6e8e"
                }
            ],
            "types": [
                "OPEN"
            ]
        }
    ],
    "resume_offset": "MTAwMDAwMDAyMjg1NA",
    "subset": {
        "proportion": 0.3,
        "type": "SAMPLE"
    }
}

POST /api/events HTTP/1.1
Authorization: Bearer <authorization token>
X-UA-Appkey: <appkey>
Accept: application/vnd.urbanairship+x-ndjson; version=3;
Content-Type: application/json

{
    "filters": [
        {
            "device_types": [
                "android",
                "amazon"
            ],
            "devices": [
                {
                    "channel": "5b389366-7caf-43e2-a19c-6159c7ea9936"
                },
                {
                    "channel": "c8044c8a-d5fa-4e58-91d4-54d0f70b7409"
                },
                {
                    "named_user_id": "George"
                }
            ],
            "latency": 20000000
        },
        {
            "notifications": [
                {
                    "group_id": "a30abf06-7878-4096-9535-b50ac0ad6e8e"
                }
            ],
            "types": [
                "OPEN"
            ]
        }
    ],
    "resume_offset": "MTAwMDAwMDAyMjg1NA",
    "subset": {
        "proportion": 0.3,
        "type": "SAMPLE"
    }
}

HTTP/1.1 200 OK
Content-encoding: gzip
Content-Type: application/vnd.urbanairship+json; version=3;

{"id" : "ff76bb85-74bc-4511-a3bf-11b6117784db", "type": "UNINSTALL", "offset": "MTIzNQ", "occurred": "2015-05-03T02:32:12.088Z", "processed": "2015-05-03T12:12:43.180Z", "device": {"channel":"a61448e1-be63-43ee-84eb-19446ba743f0", "device_type":"ANDROID", "android_channel": "a61448e1-be63-43ee-84eb-19446ba743f0"}}
{"id" : "8e50350e-dd9f-41af-b98e-b0e5d4b27dea","type": "SEND","offset": "NTIxMDM1","occurred": "2015-05-02T02:31:22.088Z","processed": "2015-05-02T02:32:43.181Z","device": {"channel":"5117f2a7-ba58-4981-9456-169959511d1a", "device_type":"IOS", "ios_channel": "5117f2a7-ba58-4981-9456-169959511d1a" },"body": {"push_id": "0c173744-dd35-4b5e-9f7f-2b7e0ce0e36e", "alerting": true}}
{"id" : "ff76bb85-74bc-4511-a3bf-11b6117784db", "type": "UNINSTALL", "offset": "MTIzNQ", "occurred": "2015-05-03T02:32:12.088Z", "processed": "2015-05-03T12:12:43.180Z", "device": {"channel":"a61448e1-be63-43ee-84eb-19446ba743f0", "device_type":"ANDROID", "android_channel": "a61448e1-be63-43ee-84eb-19446ba743f0"}}
{"device":{"channel":"820e4493-e4c9-4577-99bc-a98180599f73","delivery_address":"new.user@urbanairship.com","device_type":"EMAIL"},"id":"00000169-4a14-67b2-1ddd-d9e733622c3a","occurred":"2019-03-04T19:00:45.106Z","offset":"1000001260057","processed":"2019-03-04T19:00:47.094Z","type":"FIRST_OPT_IN"}

POST /api/events HTTP/1.1
Authorization: Bearer <authorization token>
X-UA-Appkey: <appkey>
Accept: application/vnd.urbanairship+x-ndjson; version=3;
Content-Type: application/json

{
    "filters": [
        {
            "device_types": [
                "android",
                "amazon"
            ],
            "devices": [
                {
                    "channel": "5b389366-7caf-43e2-a19c-6159c7ea9936"
                },
                {
                    "channel": "c8044c8a-d5fa-4e58-91d4-54d0f70b7409"
                },
                {
                    "named_user_id": "George"
                }
            ],
            "latency": 20000000
        },
        {
            "notifications": [
                {
                    "group_id": "a30abf06-7878-4096-9535-b50ac0ad6e8e"
                }
            ],
            "types": [
                "OPEN"
            ]
        }
    ],
    "resume_offset": "MTAwMDAwMDAyMjg1NA",
    "subset": {
        "proportion": 0.3,
        "type": "SAMPLE"
    }
}

HTTP/1.1 200 OK
Content-encoding: gzip
Content-Type: application/vnd.urbanairship+json; version=3;

{"id" : "ff76bb85-74bc-4511-a3bf-11b6117784db", "type": "UNINSTALL", "offset": "MTIzNQ", "occurred": "2015-05-03T02:32:12.088Z", "processed": "2015-05-03T12:12:43.180Z", "device": {"channel":"a61448e1-be63-43ee-84eb-19446ba743f0", "device_type":"ANDROID", "android_channel": "a61448e1-be63-43ee-84eb-19446ba743f0"}}
{"id" : "8e50350e-dd9f-41af-b98e-b0e5d4b27dea","type": "SEND","offset": "NTIxMDM1","occurred": "2015-05-02T02:31:22.088Z","processed": "2015-05-02T02:32:43.181Z","device": {"channel":"5117f2a7-ba58-4981-9456-169959511d1a", "device_type":"IOS", "ios_channel": "5117f2a7-ba58-4981-9456-169959511d1a" },"body": {"push_id": "0c173744-dd35-4b5e-9f7f-2b7e0ce0e36e", "alerting": true}}
{"id" : "ff76bb85-74bc-4511-a3bf-11b6117784db", "type": "UNINSTALL", "offset": "MTIzNQ", "occurred": "2015-05-03T02:32:12.088Z", "processed": "2015-05-03T12:12:43.180Z", "device": {"channel":"a61448e1-be63-43ee-84eb-19446ba743f0", "device_type":"ANDROID", "android_channel": "a61448e1-be63-43ee-84eb-19446ba743f0"}}
{"device":{"channel":"820e4493-e4c9-4577-99bc-a98180599f73","delivery_address":"new.user@urbanairship.com","device_type":"EMAIL"},"id":"00000169-4a14-67b2-1ddd-d9e733622c3a","occurred":"2019-03-04T19:00:45.106Z","offset":"1000001260057","processed":"2019-03-04T19:00:47.094Z","type":"FIRST_OPT_IN"}

{
   "id": "8e50350e-dd9f-41af-b98e-b0e5d4b27dea",
   "type": "SEND",
   "offset": "NTIxMDM1",
   "occurred": "2015-05-02T02:31:22.088Z",
   "processed": "2015-05-02T02:32:43.181Z",
   "device": {
      "channel": "5117f2a7-ba58-4981-9456-169959511d1a",
      "device_type": "IOS"
   },
   "body": {
      "push_id": "0c173744-dd35-4b5e-9f7f-2b7e0ce0e36e",
      "alerting": true
   }
}
{
  "device": {
    "channel": "820e4493-e4c9-4577-99bc-a98180599f73",
    "delivery_address": "new.user@urbanairship.com",
    "device_type": "EMAIL"
  },
  "id": "00000169-4a14-67b2-1ddd-d9e733622c3a",
  "occurred": "2019-03-04T19:00:45.106Z",
  "offset": "1000001260057",
  "processed": "2019-03-04T19:00:47.094Z",
  "type": "FIRST_OPT_IN"
}

Opens a new event stream according to your request filters. Unlike our other APIs, a request to /api/events/ returns a stream of data, where each line is a JSON object. The response body contains all the events in that stream. Since streams by definition go on forever, Real-Time Data Streaming will never end the response without some external reason.

Security:

Request headers:

• X-UA-Appkey stringREQUIRED
  The App Key for the project you want to return events for.

Request body:

• Content-Type: application/json

  Events request

  The request body defines the events you want to return in the event stream. You can define position, subset and filter specifications in each request submitted to the stream. Filters are positive statements about what events the client should return. The subset specification returns a representative portion of the stream.

Responses

• 200

  The response to a successful request is an unending stream of newline-delimited JSON . Each non-empty line in the response represents a single event.

  This response body is of arbitrarily large size. As long as the connection is open, Airship will continue to write to the data stream. If no events have been dispatched down a connection for some time, the API will write to the connection to prevent it from being closed for inactivity. By default, only a blank line (a single newline character) will be written. If the enable_offset_updates field in the request is true, then instead of a blank line, an event will be written with type OFFSET_UPDATE. These events have no body or device field, and always have occurred and processed times indicating when they were sent. The offset field will contain the offset of the last event considered for inclusion in the stream whether or not it was actually sent. This may be useful to track position in the stream when using a filter which removes much of it.

  These events should not be stored, and will be different for every connection even if requests are identical. OFFSET_UPDATE events are not subject to filters, and if requested will be delivered regardless of those specified. You should always check the type field before handling any delivered event.

  If you receive no data or new line characters for ninety seconds, close the connection and reconnect.

  Response body:

  • Content-Type: application/vnd.urbanairship+x-ndjson; version=3;
    One of
    • Attribute operation event

      Attribute operation events indicate a change in the device’s attributes. Because attribute operations are related to a device, they will have a device field.

      If you set an attribute on a Named User, Airship records events for each device associated with the Named User.

    • Close

      Occurs when a user closes the app. Close events are often latent, as they aren’t sent back to Airship until the user activates the app again.

    • Contact change

      Occurs when a contact is uninstalled, associated with a channel or Named User, or dissociated from a channel or Named User.

    • Control

      Occurs when a device is excluded from a push because it was arbitrarily selected as a member of a control group for a Message A/B test, Sequence A/B test, or Holdout Experiment.

    • Custom

      Represents Custom Events that are either emitted from the Airship SDK or submitted through the Custom Events API. You can configure Custom Events yourself. There are also several CUSTOM-type events for email and SMS that are defined by Airship.

      In general, you can expect device information if the event source is SDK or if the event is one of the defined email or SMS events (as defined by event_type).

    • First open

      This event occurs when a user opens an Airship-integrated app for the first time.

    • First opt-in

      This event appears in the stream when a channel is first opted in. This event is specific to email (commercial), SMS, and open channels.

    • In-app button tap

      Occurs when a button is tapped within a Scene.

    • In-app message display

      Occurs when an In-App Automation or Scene is displayed to a user. Because the event pertains to a specific device, the device information object will be populated.

    • In-app message expiration

      Occurs when a new In-App Automation or Scene message has taken the place of another message, a message has passed its expiration, or because displaying the message in-app would be redundant. This event type may be latent. It is not emitted until the app becomes active.

    • In-app message resolution

      Occurs when an In-App Automation or Scene is cleared from the display, either by user action or timeout. Because this event pertains to an individual device, the device information object will be present.

    • In-app page swipe

      Occurs when a user swipes to the next or previous page (screen) in a pager (specific to Scenes).

    • In-app page view

      Occurs when a page (screen) is displayed within a pager (specific to Scenes).

    • In-app pager completed

      Occurs when the last page (screen) of a pager is viewed for the first time (specific to Scenes).

    • In-app pager summary

      Describes the full path a user took within a pager (specific to Scenes), including the order of pages (screens) visited and time spent per page.

    • Label event

      Occurs when you update a Scene screen name.

    • Location

      An event declaring the device to be at a particular latitude and longitude.

    • Mobile originated event

      Represents a message action that originated from a user — like an inbound SMS or email.

    • Open

      Occurs when a user opens your app.

    • Push body

      Occurs when you initiate a push, automation, or sequence.

      Airship fulfills delivery over a time interval with a number of child pushes, each with a unique Push ID and a common Group ID. There is no guarantee that push body events (defined in Push Body Event) for the child pushes fulfilling a group will appear in the stream.

      Note: When you start, pause, or publish a sequence, Airship emits a push_body event for the sequence itself, and each message contained within the sequence (i.e., messages +1). After you start a sequence, Airship does not issue subsequent push_body events for the sequence unless you pause or publish changes to the sequence.

    • Region event

      Region events are emitted when a device enters or exits a geofence or the range of any of a set of bluetooth beacons. Region events require a Gimbal integration. Events for Gimbal customers include the Gimbal application instance identifier as com.urbanairship.gimbal.aii within the identifiers object.

    • Rich control

      Occurs when a Message Center message is not delivered to a user because they are in a control group for a Sequence A/B test or Holdout Experiment.

    • Rich delete

      Occurs when a user deletes a Message Center message from their inbox.

    • Rich delivery

      Occurs when a Message Center message is delivered to a user’s inbox.

      Even though rich push deliveries may or may not cause an alert on the user’s lock screen, they are always associated with a push identifier in the Airship system.

    • Rich read

      Occurs when a user reads a Message Center message in their inbox.

    • Screen viewed

      Occurs when a user has finished viewing a screen. It is up to you to instrument your application with names for each screen. Doing so will allow you to determine the user’s path by filtering on the fields in the table below.

    • Send

      Occurs whenever a push notification is sent to a device identified in the audience selector of a message.

    • Send aborted

      Occurs when a push is dropped from our system before delivery is attempted. This can happen:

      • When using External Data Feeds to personalize a message and an error was encountered or the feed returned a non-successful response
      • When a Message Limit is met
      • When a Ban List webhook issues a drop response for a user

      Device information for the device that did not receive the push is included with SEND_ABORTED events.

    • Send rejected

      Occurs when a push fails during communication with a third party, like APNs or GCM. This typically indicates that the user has uninstalled the app or otherwise invalidated the last-registered credentials stored in Airship. The event contains the rejected push and the group, variant, or campaigns the push belonged to.

      Device information for the device that did not receive the push is included with SEND_REJECTED events.

    • Short link click event

      Occurs when a user taps or “clicks” an Airship-shortened link in an SMS or MMS message.

    • Subscription event

      SUBSCRIPTION events reflect changes to users’ subscription preferences — reflected in opt_in and opt_out values. These events help you track a user’s subscription status in the system and the total number of subscribers.

    • Subscription list event

      Occurs when subscription list enrollment changes for a device or user.

    • Tag change

      Occurs when tags change for a device.

    • Uninstall

      Occurs when a user uninstalls an Airship-integrated app in response to a push.

    • Web click event

      Occurs when a user interacts with a web notification, e.g., clicked or tapped it. Web Click events have a device attribute on the event indicating the channel that was the target of the notification. The body of a Web Click Event is an associated push object.

    • Web session event

      Occurs when an opted in user begins interacting with a website. Web Session events have a device attribute, indicating the channel associated with the user.

• 402

  Like other Airship applications, Real-Time Data Streaming supports a limited number of simultaneous connections. If you exceed this number, you may receive this response.

• 404

  We do not have data for the specified App key. This is likely because we have yet to ingress or generate any data for your app.

Compliance Event Stream

The compliance event stream provides real-time access to COMPLIANCE type events. This endpoint is open to all Airship users.

Open a compliance event stream

POST /api/events/general

POST /api/events/general HTTP/1.1
Authorization: Basic <master authorization string>
X-UA-Appkey: <appkey>
Accept: application/vnd.urbanairship+x-ndjson; version=3;
Content-Type: application/json

{
  "start":"LATEST",
  "enable_offset_updates": true
}

POST /api/events/general HTTP/1.1
Authorization: Basic <master authorization string>
X-UA-Appkey: <appkey>
Accept: application/vnd.urbanairship+x-ndjson; version=3;
Content-Type: application/json

{
  "start":"LATEST",
  "enable_offset_updates": true
}

HTTP/1.1 200 OK
Content-encoding: gzip
Content-Type: application/vnd.urbanairship+json; version=3;

{
  "id": "9781ff2e-fa4a-4fa8-bd9d-41f318c48963",
  "offset": "1000001778910",
  "occurred": "2018-11-28T00:02:41.794Z",
  "processed": "2018-11-28T00:02:45.270Z",
  "device": {
      "channel": "5a39b6d8-0a5a-4c2b-a4a0-3d4a71e5254b",
      "device_type": "EMAIL",
      "delivery_address": "bogus@example.com"
  },
  "body": {
      "event_type": "bounce",
      "properties": {
          "bounce_event_type": "bounce",
          "sender": "msprvs1=17870ayYKWpBI=bounces-179492-4@example.com",
          "subject": "You there?",
          "email": "bogus@example.com",
          "bounce_class": "10"
      }
  },
  "type": "COMPLIANCE"
}

Opens a stream delivering events proving data-safety regulation compliance for email and SMS channel-related events (registration, unsubscription, etc.).

Unlike a standard event stream, a compliance event stream uses basic authorization, like API calls to https://go.urbanairship.com/api.

Security:

Request headers:

• X-UA-Appkey stringREQUIRED
  The App Key for the project you want to return compliance events for.

Request body:

• Content-Type: application/json

  Compliance request

  A request for compliance events is much like a request to /api/events, but has a limited scope.

Responses

• 200

  The response to a successful request is an unending stream of newline-delimited JSON . Each non-empty line in the response represents a single compliance event. Unlike events in a normal event stream, this endpoint returns events of the compliance type, and is open to SMS and email customers. As long as the connection is open, Airship will continue to write to the event stream.

  If a stream records no events for a period of time, the API will write a blank line (a single newline character) to the connection to prevent it from being closed for inactivity. If the enable_offset_updates field in the request is true, then the blank line is replaced with an OFFSET_UPDATE event. These events have no body or device field, and always have occurred and processed times indicating when they were sent. The offset field will contain the offset of the last event considered for inclusion in the stream whether or not it was actually sent. This may be useful to track position in the stream when using a filter which removes much of it.

  You should not store these events; they will be different for every connection even if requests are identical. OFFSET_UPDATE events are not subject to filters, and are delivered even if not specified in the list of events you want to return. You should always check the type field before handling any delivered event.

  If you do not receive data or new line characters for ninety seconds, close the connection and reconnect.

  Response body:

  • Content-Type: application/vnd.urbanairship+x-ndjson; version=3;

    Events relating to regulatory compliance for email and SMS channels.

    All of
    • OBJECT PROPERTIES
      • id stringREQUIRED

        Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

      • occurred stringREQUIRED

        When the event occurred.

      • offset string

        An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

      • processed stringREQUIRED

        When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

      • type stringREQUIRED

        Compliance events are the only types of events returned by this event stream.

        Possible values: COMPLIANCE

Data Formats

SMS compliance events

Contains event body information specific to SMS compliance events.

SMS API initiated opt-in event

{
    "id": "a11d6d6b-bdd1-4f3d-97d3-591993945425",
    "offset": "1000005312986",
    "occurred": "2019-07-10T17:11:48.923Z",
    "processed": "2019-07-10T17:11:49.151Z",
    "device": {
        "channel": "35eb0446-0c75-44ec-ba9e-81d7250e0e06",
        "device_type": "SMS"
    },
    "body": {
        "event_type": "api_initiate_opt_in",
        "identifiers": {
            "sender": "18338647425",
            "msisdn": "15035508427"
        }
    },
    "type": "COMPLIANCE"
}

Occurs when an SMS user is registered via the SMS Channel Registration API without an opted_in value — indicating that the user has initiated, but not completed, the registration process. While this event contains a channel_id, you cannot send messages to this channel until the associated user completes the opt-in process (indicated by a mobile_opt_in event).

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Indicates a registration was started via the Airship API without an opt-in date, and a message was sent to the end user with instructions on how to opt in.

    Possible values: api_initiate_opt_in

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS carrier deactivation event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663"
  },
  "body": {
    "event_type": "carrier_deactivation",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when an MSISDN is deactivated by a carrier. This event type does not contain additional properties.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    The carrier deactivated the address.

    Possible values: carrier_deactivation

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

SMS custom keyword response event

{
    "id": "34464823-b48c-4ed3-8849-03933f29d057",
    "offset": "1000005313855",
    "occurred": "2019-07-11T00:24:39.203Z",
    "processed": "2019-07-11T00:24:40.128Z",
    "device": {
        "channel": "ec71312b-42e4-4bcd-b742-581a84941793",
        "device_type": "SMS",
        "delivery_address": "15035508427",
        "identifiers": {
            "sender": "18338647425"
        }
    },
    "body": {
        "event_type": "custom_keyword_response",
        "identifiers": {
            "sender": "18338647425",
            "msisdn": "15035508427"
        },
        "properties": {
            "inbound_message": "coupon",
            "outbound_message": "Thanks! Here is your coupon! https:\/\/wallet-api.urbanairship.com\/v1\/pass\/adaptive\/M1kTVOcyXm"
        }
    },
    "type": "COMPLIANCE"
}

Occurs when a mobile-originated keyword is matched, and elicits a custom response.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Occurs when a mobile-originated keyword generates a custom response.

    Possible values: custom_keyword_response

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Contains properties specific to the event_type.

    OBJECT PROPERTIES
    • inbound_message string

      The body of the inbound (to Airship) text message. This is the message a user sent to opt into or out of messages. This text corresponds to the keyword if present.

    • outbound_message string

      The message you sent to the user represented in the event.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS mobile create channel event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663"
  },
  "body": {
    "event_type": "mobile_create_channel",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    },
    "properties": {
      "inbound_message": "JOIN",
      "outbound_message": "Your order number is #123456789. Text 'JOIN' to learn about new offers from us.",
      "keyword": "JOIN"
    }
  },
  "type": "COMPLIANCE"
}

If a channel does not exist for the MSISDN/sender combination and your account is configured to create a channel if none exists in such instances, we will emit this event. The resulting channel will necessarily be opted out, awaiting an opt-in action by the user.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Indicates that a channel for the sms event type was created.

    Possible values: mobile_create_channel

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Contains properties specific to the event_type.

    OBJECT PROPERTIES
    • opted_in string

      The date and time when the channel was registered.

    • registration_type string

      Indicates that the channel was registered with Airship.

      Possible values: create

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS mobile keyword matched event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663"
  },
  "body": {
    "event_type": "mobile_keyword_matched",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    },
    "properties": {
      "inbound_message": "join",
      "outbound_message": "Wanna join the club?",
      "keyword": "JOIN"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when a mobile-originated message contains a recognized keyword.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Occurs when a mobile-originated event contains a recognized keyword.

    Possible values: mobile_keyword_matched

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Contains properties specific to the event_type.

    OBJECT PROPERTIES
    • inbound_message string

      The body of the inbound (to Airship) text message. This is the message a user sent to opt into or out of messages. This text corresponds to the keyword if present.

    • keyword string

      Indicates that a mobile-originated message contained a recognized keyword.

    • outbound_message string

      The message you sent to the user represented in the event.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS mobile keyword unmatched event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663"
  },
  "body": {
    "event_type": "mobile_keyword_unmatched",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    },
    "properties": {
      "inbound_message": "@%#!&@&#",
      "outbound_message": "Wanna join the club?"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when a mobile-originated message does not contain a recognized keyword.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Occurs when a mobile-originated event does not contain a recognized keyword.

    Possible values: mobile_keyword_unmatched

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Contains properties specific to the event_type.

    OBJECT PROPERTIES
    • inbound_message string

      The body of the inbound (to Airship) text message. This is the message a user sent to opt into or out of messages. This text corresponds to the keyword if present.

    • outbound_message string

      The message you sent to the user represented in the event.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS mobile opt in event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663"
  },
  "body": {
    "event_type": "mobile_opt_in",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    },
    "properties": {
      "inbound_message": "y",
      "outbound_message": "Do you want to get text alerts from us?",
      "keyword": "Y"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when a user opts in to text messages via a keyword.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Indicates that the event represents a newly registered address.

    Possible values: mobile_opt_in

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Contains properties specific to the event_type.

    OBJECT PROPERTIES
    • inbound_message string

      The body of the inbound (to Airship) text message. This is the message a user sent to opt into or out of messages. This text corresponds to the keyword if present.

    • keyword string

      The keyword the user sent to opt in.

    • outbound_message string

      The message you sent to the user represented in the event.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS mobile opt out event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663"
  },
  "body": {
    "event_type": "mobile_opt_out",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    },
    "properties": {
      "inbound_message": "STOP",
      "outbound_message": "Text STOP to opt out of text messages from us.",
      "keyword": "STOP"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when a user sends a MO message that matches a keyword with an opt-out action. If present, this event would supplant a mobile_keyword_matched event.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    The event represents a user who opted out of notifications.

    Possible values: mobile_opt_out

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Contains properties specific to the event_type.

    OBJECT PROPERTIES
    • inbound_message string

      The body of the inbound (to Airship) text message. This is the message a user sent to opt into or out of messages. This text corresponds to the keyword if present.

    • keyword string

      Indicates that the user responded to opt out of messages. The enumerated values represent default keywords, but any custom keywords that you configure to allow mobile opt-outs can also appear here.

      Possible values: STOP, STOPALL, UNSUBSCRIBE, CANCEL, END, QUIT, ARRET

    • outbound_message string

      The message you sent to the user represented in the event.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS mobile terminated message event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS"
  },
  "body": {
    "event_type": "mobile_terminated_message",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when Airship sends an SMS message to a user. The message represented by this event could be a response to an individual mobile-originated (MO) message, or a message initiated from the Airship UI/API.

• body objectREQUIRED

  Contains the Compliance event subtype and properties specific to the event subtype.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Airship has emitted a mobile-terminated message.

    Possible values: mobile_terminated_message

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS opted out event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663",
    "identifiers": { "sender": "15558675309" }
  },
  "body": {
    "event_type": "opted_out",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when a user is opted out of an SMS audience via the Airship API, i.e., not via an opt-out keyword. This event type does not contain additional properties.

• OBJECT PROPERTIES
  • device object

    Holds information about an SMS device (an individual SMS channel).

    OBJECT PROPERTIES
    • channel string

      The unique, platform-agnostic channel identifier for a device.

    • delivery_address string

      The phone number for the channel.

    • device_type stringREQUIRED

      SMS compliance events use the SMS device type.

      Possible values: SMS

    • identifiers object

      If present, the identifiers object holds the value for the sender property.

      OBJECT PROPERTIES
      • sender stringREQUIRED

        The sender that the delivery_address received a message from.

  • id string

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred string

    When the event occurred.

  • offset string

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed string

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type string

    Compliance events are the only types of events returned by this event stream.

    Possible values: COMPLIANCE

• OBJECT PROPERTIES
  • body objectREQUIRED

    Contains the event subtype, identifiers, and additional properties about the event.

    OBJECT PROPERTIES
    • event_type stringREQUIRED

      The address opted out of notifications.

      Possible values: opted_out

    • identifiers objectREQUIRED

      Contains the sender and MSISDN for the event.

      OBJECT PROPERTIES
      • msisdn stringREQUIRED

        The phone number of the user involved in the compliance event.

      • sender stringREQUIRED

        The phone number or short code of the sender involved in the compliance event.

SMS Create and Send event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663"
  },
  "body": {
    "event_type": "create_and_send",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    },
    "properties": {
      "opted_in": "2018-12-03T19:31:10.000Z",
      "channel_registered": "true"
    }
  },
  "type": "COMPLIANCE"
}

An event that occurs for SMS channels used as a part of a Create and Send.

• body objectREQUIRED

  Contains the event subtype and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Possible values: create_and_send

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Properties for an SMS Create and Send event.

    OBJECT PROPERTIES
    • channel_registered booleanREQUIRED

      If true, a new channel was created to represent the identifiers in the event. If false, the address was already registered to Airship.

    • opted_in string

      The date-and-time when the msisdn opted into messages from the sender.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS registration event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS"
  },
  "body": {
    "event_type": "registration",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    },
    "properties": {
      "opted_in": "2018-12-03T19:31:10.000Z",
      "registration_type": "create"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when a user opts in to receive SMS messages from you, via a call to the SMS registration API.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Indicates that the event represents a newly registered address.

    Possible values: registration

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Contains properties specific to the event_type.

    OBJECT PROPERTIES
    • opted_in stringREQUIRED

      The ISO 8601 date-time (UTC) when the channel opted-in to notifications.

    • registration_type stringREQUIRED

      Indicates whether the channel was created or updated.

      Possible values: create, update

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS update event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663",
    "identifiers": {
      "sender": "15558675309"
    }
  },
  "body": {
    "event_type": "registration",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    },
    "properties": {
      "registration_type": "update"
    }
  },
  "type": "COMPLIANCE"
}

When an SMS event update occurs.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    Indicates that the event represents a newly registered address.

    Possible values: registration

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

  • properties objectREQUIRED

    Contains properties specific to the event_type.

    OBJECT PROPERTIES
    • opted_in stringREQUIRED

      The ISO 8601 date-time (UTC) when the channel opted-in to notifications.

    • registration_type stringREQUIRED

      Indicates the channel was updated.

      Possible values: update

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

SMS uninstalled event

{
  "id": "a7086338-0473-46fe-8d9b-cb61305c3c0d",
  "offset": "1000000701505",
  "occurred": "2018-12-03T19:31:10.000Z",
  "processed": "2018-12-03T19:31:11.302Z",
  "device": {
    "channel": "a828de17-b315-4e80-9d2d-35a906afeacf",
    "device_type": "SMS",
    "delivery_address": "15558968663",
    "identifiers": {
      "sender": "15558675309"
    }
  },
  "body": {
    "event_type": "uninstall",
    "identifiers": {
      "sender": "15558675309",
      "msisdn": "15558968663"
    }
  },
  "type": "COMPLIANCE"
}

Occurs when the SMS uninstall API is called.

• body objectREQUIRED

  Contains the event subtype, identifiers, and additional properties about the event.

  OBJECT PROPERTIES
  • event_type stringREQUIRED

    The address was uninstalled.

    Possible values: uninstall

  • identifiers objectREQUIRED

    Contains the sender and MSISDN for the event.

    OBJECT PROPERTIES
    • msisdn stringREQUIRED

      The phone number of the user involved in the compliance event.

    • sender stringREQUIRED

      The phone number or short code of the sender involved in the compliance event.

• device objectREQUIRED

  Holds information about an SMS device (an individual SMS channel).

  OBJECT PROPERTIES
  • channel string

    The unique, platform-agnostic channel identifier for a device.

  • delivery_address string

    The phone number for the channel.

  • device_type stringREQUIRED

    SMS compliance events use the SMS device type.

    Possible values: SMS

  • identifiers object

    If present, the identifiers object holds the value for the sender property.

    OBJECT PROPERTIES
    • sender stringREQUIRED

      The sender that the delivery_address received a message from.

Device information

Events are ascribed to devices. App, web, SMS, email, and open channel devices return different information.

App device information

{
    "channel": "a6b392d6-3b0d-4c00-98ef-5cb91d51268a",
    "device_type": "IOS",
    "named_user_id": "Albert",
    "identifiers": {
      "com.urbanairship.idfa": "fb0d01e0-9e21-4466-9217-8eacfd2b81c7",
      "com.urbanairship.gimbal.aii": "c5720f06-516a-4b91-b7bb-53523fc43a3d",
      "com.urbanairship.limited_ad_tracking_enabled": "false"
    },
    "attributes": {
      "app_package_name": "com.company_name.app_name",
      "app_version": "1.0.0",
      "ua_sdk_version": "7.0.2"
    }
  }

Information about app users generated by the SDK.

• amazon_channel string

  The identifier for a Fire OS channel. In general, this is also the same value as the channel.

• android_channel string

  The identifier for an Android channel. In general, this is also the same value as the channel.

• attributes object

  Attributes specific to app devices.

  OBJECT PROPERTIES
  • app_package_name string

    A unique identifier for the app name.

  • app_version string

    The version of the app.

  • background_push_enabled string

    Indicates whether or not the device has background push notifications enabled.

    Possible values: true, false

  • carrier stringDEPRECATED

    The wireless carrier used by the device. Deprecation notice: This property will not be collected as of SDK 20 for both iOS and Android and will be removed on October 8, 2025.

  • connection_type stringDEPRECATED

    The internet connection type used by the device. Deprecation notice: This property will not be collected as of SDK 20 for both iOS and Android and will be removed on October 8, 2025.

    Possible values: WIFI, CELL, WIMAX, NONE

  • device_model string

    The device model.

  • device_os string

    The device operating system.

  • iana_timezone string

    The time zone of the device.

  • locale_country_code string

    The ISO 3166-1 country code as defined in device settings.

  • locale_language_code string

    The ISO 639-1 two-letter language code reflecting the language that the device is set to.

  • locale_timezone string

    The device’s time zone offset in seconds from UTC.

  • locale_variant string

    The language variant.

  • location_enabled string

    Indicates whether or not the device has location services enabled.

    Possible values: true, false

  • location_permission string
    • SYSTEM_LOCATION_DISABLED Location is disabled in system settings
    • NOT_ALLOWED Android: missing manifest permissions, iOS: opted out
    • ALWAYS_ALLOWED Android: has manifest permissions, iOS: opted in background and foreground
    • FOREGROUND_ALLOWED iOS only: opted in foreground only
    • UNPROMPTED: iOS only

    Possible values: SYSTEM_LOCATION_DISABLED, NOT_ALLOWED, ALWAYS_ALLOWED, FOREGROUND_ALLOWED, UNPROMPTED

  • push_opt_in string

    Indicates whether or not the device is opted into push notifications.

  • ua_sdk_version string

    The version of the Airship SDK used in the app.

• channel stringREQUIRED

  The unique, platform-agnostic channel identifier for a device.

• device_type stringREQUIRED

  The platform that the channel is on.

  Possible values: IOS, ANDROID, AMAZON

• identifiers object

  Identifying information specific to app devices.

  OBJECT PROPERTIES
  • com.urbanairship.aaid string

    Android/Fire OS ad identifier

  • com.urbanairship.gimbal.aii string

    Gimbal application instance identifier

  • com.urbanairship.idfa string

    Apple ad identifier

  • com.urbanairship.limited_ad_tracking_enabled string

    If true, the user has enabled limited ad tracking.

    Possible values: true, false

  • com.urbanairship.vendor string

    Apple vendor identifier

• ios_channel string

  The identifier for an iOS channel. In general, this is also the same value as the channel.

• named_user_id string

  The Named User identifier for the device.

Named User

User information for events which occur at the user level.

• named_user_id stringREQUIRED

  The Named User identifier for the device.

Open channel device information

Information about open channel users.

• channel string

  The unique, platform-agnostic channel identifier for a device.

• device_type string

  The platform that the channel is on.

  Possible values: OPEN

• named_user_id string

  The Named User identifier for the device.

• open_platform_name string

  If device_type is set to OPEN, this field shows the full name of the platform.

Device information for SMS and email

Information about the SMS or email device related to an event.

• channel stringREQUIRED

  The channel identifier.

• delivery_address string
  • If device_type is SMS, this field shows the MSISDN.
  • If device_type is EMAIL, this field shows the email address.

• device_type stringREQUIRED

  The platform that the channel is on.

  Possible values: EMAIL, SMS

• named_user_id string

  The Named User the channel is associated with.

Web device information

Information about web users generated by the SDK.

• attributes object
  OBJECT PROPERTIES
  • iana_timezone string

    The time zone of the device.

  • locale_country_code string

    The ISO 3166-1 country code as defined in device settings.

  • locale_language_code string

    The ISO 639-1 two-letter language code reflecting the language that the device is set to.

  • locale_timezone string

    The device’s time zone offset in seconds from UTC.

  • locale_variant string

    The language variant.

  • push_opt_in stringREQUIRED

    Indicates whether or not the device is opted into push notifications.

  • ua_sdk_version stringREQUIRED

    The version of the Airship SDK used in the app.

  • web_browser_name stringREQUIRED

    The name of the browser running the SDK.

  • web_browser_type stringREQUIRED

    Indicates whether the browser was running on a desktop or mobile device.

  • web_browser_version stringREQUIRED

    The version of the browser.

  • web_user_agent_string stringREQUIRED

    The user agent reported by the browser.

• channel stringREQUIRED

  The unique, platform-agnostic channel identifier for a device.

• device_type stringREQUIRED

  The platform that the channel is on.

  Possible values: WEB

• named_user_id string

  The Named User identifier for the device.

JSON Predicates

Provides a flexible language for expressing custom filtering of your event stream.

Array matcher

{
  "filters": {
    "types": ["PUSH_BODY"],
    "predicates": {
      "key": "categories",
      "scope": ["body", "campaigns"],
      "value": {
        "array_contains": { "value": {"equals": "spring_sale"} }
      }
    }
  }
}  

Determines if an array contains an object that matches another criteria.

• OBJECT PROPERTIES
  • array_contains object

    The JSON Predicate.

• OBJECT PROPERTIES
  • array_contains object

    The JSON Predicate.

  • index number

    The specified element in the array.

Equals matcher

{
  "filters": [
    {
      "device_types": ["sms"],
      "types": ["CUSTOM"],
      "predicates": [
        {
          "and": [
            {
              "key": "interaction_type",
              "scope": ["body"],
              "value": {"equals": "delivery_report"}
            },
            {
              "not": {
                "key": "name",
                "scope": ["body"],
                "value": {"equals": "delivered"}
              }
            }
          ]
        }
      ]
    }
  ]
}

Determines if the value matches exactly.

• equals object
  One of
  • string
  • array<oneOf>

JSON Predicate

{
  "filters": {
    "predicates": {
      "and": [
        {
          "scope": ["device"],
          "key": "device_type",
          "value": {"equals": "ANDROID"}
        },
        { "key": "type", "value": {"equals": "OPEN"} }
      ]
    }
  }
}

Standard request filters check specific, predefined fields in your events and remove any events that don’t match the criteria for that field. For example, the device_types filter always checks the device_type sub-field of the device object. In contrast, you can use JSON Predicates to examine any part of an event, providing more flexibility than the standard filters. You can also combine multiple JSON Predicate objects to create complex filtering logic for your event stream.

The simplest JSON Predicate examines a single key and provides a matcher object that can be applied to the value at that key. To filter a stream for only Open events, you could use the standard filter types: filters:{"types": ["OPEN"]}. However, to achieve this with a JSON Predicate, you would use filters:{"predicates":{"key":"type", "value": {"equals": "OPEN"}}}. This checks the value of the top-level key type to see if it’s exactly “OPEN”. It also serves as a foundational step for constructing more intricate filters.

To filter for only Android events, you could use the device_type filter, but a JSON Predicate allows for more complex combinations later. Since the device type key doesn’t appear at the top level of the event, you’ll need to provide a scope, like this filters:{"predicates":{"scope":["device"], "key":"device_type", "value": {"equals": "ANDROID"}}}. This configuration targets the device_type key within the device object, checking if its value is “ANDROID”.

You can combine the two filters to see only Opens from Android devices: filters:{"predicates":{"and":[ {"scope":["device"], "key":"device_type", "value": {"equals": "ANDROID"}}, {"key":"type", "value": {"equals": "OPEN"}} ]}}

We also have matchers other than equals. Numeric at_least and at_most can be combined to create ranges. version_matches uses Ivy syntax  to match version numbers. is_present determines if there’s any value at a given key. array_contains can be combined with another predicate to determine if an array contains an object that matches another criteria.

• And object
  OBJECT PROPERTIES
  • and array
• Or object
  OBJECT PROPERTIES
  • or array
• Not object
  OBJECT PROPERTIES
  • not object

    The JSON Predicate.

• Value object
  OBJECT PROPERTIES
  • key stringREQUIRED

    The name of the value being matched.

  • scope object

    The path into a JSON object.

    One of
    • string
    • array<string>
  • value objectREQUIRED

    The value you are filtering for in the JSON Predicate.

    One of
    • Array_matcher

      Determines if an array contains an object that matches another criteria.

    • Equals_matcher

      Determines if the value matches exactly.

    • Numeric_matcher

      Determines if a number matches or is within range of the criteria.

    • Presence_matcher

      Determines if there is any value for a given key.

    • Version_matcher

      Determines if version numbers match.

Numeric matcher

{
  "filters": [
    {
      "types": ["CUSTOM"],
      "predicates": [
        {
          "and": [
            { "key": "value",
              "scope": ["body"],
              "value": {"at_least": 100}
            },
            {
              "key": "name",
              "scope": ["body"],
              "value": {"equals": "purchase"}
            }
          ]
        }
      ]
    }
  ]
}

Determines if a number matches or is within range of the criteria.

• OBJECT PROPERTIES
  • at_least number
• OBJECT PROPERTIES
  • at_most number
• OBJECT PROPERTIES
  • at_least number
  • at_most number

Presence matcher

{
  "filters": {
    "types": ["OPEN"],
    "predicates": {
      "key": "triggering_push",
      "scope": ["body"],
      "value": {"is_present": true}
    }
  }
}

Determines if there is any value for a given key.

• is_present boolean

  If true, the value should be present. If false, the value should not be present.

Version matcher

{
  "filters": [
    {
      "device_types": ["android"],
      "types": ["CUSTOM"],
      "predicates": [
        {
          "and": [
            {
              "key": "app_version",
              "scope": ["device", "attributes"],
              "value": {"version_matches": "[18.4.1,19.2.3]"}
            },
            {
              "key": "name",
              "scope": ["body"],
              "value": {"equals": "purchase"}
            }
          ]
        }
      ]
    }
  ]
}

Determines if version numbers match.

• version_matches string

  The version number string to be matched. Format strings using Ivy syntax .

Events

Contains information about events organized by type. Some events contain additional subtypes or device information.

Attribute operation event

{
  "id": "00000173-bb88-8804-b6ec-a40f4ae36648",
  "offset": "1000059326194",
  "occurred": "2020-08-04T22:12:33.924Z",
  "processed": "2020-08-04T22:12:37.672Z",
  "device": {
      "android_channel": "b57f0e3c-da10-4a2b-99d2-5fe2cb30cad3",
      "channel": "b57f0e3c-da10-4a2b-99d2-5fe2cb30cad3",
      "device_type": "ANDROID",
      "named_user_id": "cool_user",
      "attributes": {
        "locale_variant": "",
        "app_version": "2020-02-10T222436-staging",
        "device_model": "Pixel 2 XL",
        "app_package_name": "com.company_name.app_name",
        "iana_timezone": "America/Los_Angeles",
        "push_opt_in": "true",
        "locale_country_code": "US",
        "device_os": "10",
        "locale_timezone": "-25200",
        "locale_language_code": "en",
        "location_enabled": "false",
        "background_push_enabled": "true",
        "ua_sdk_version": "12.2.0",
        "location_permission": "NOT_ALLOWED"
      }
  },
  "user": {
    "contact_id": "6b5ca2a2-c1f1-4119-9617-2d5bff0db09d",
    "named_user_id": "cool_user"
  },
  "body": {
      "set": [
        {
            "key": "first_name",
            "value": "Pierre"
        }
      ]
  },
  "type": "ATTRIBUTE_OPERATION"
}

Attribute operation events indicate a change in the device’s attributes. Because attribute operations are related to a device, they will have a device field.

If you set an attribute on a Named User, Airship records events for each device associated with the Named User.

• body objectREQUIRED
  OBJECT PROPERTIES
  • remove array[object]

    The attributes removed from the device in this event.

  • set array[object]
• device objectREQUIRED
  One of
  • Appdevices

    Information about app users generated by the SDK.

  • Webdevices

    Information about web users generated by the SDK.

  • Sms_email_devices

    Information about the SMS or email device related to an event.

  • Opendevices

    Information about open channel users.

• id stringREQUIRED

  Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

• occurred stringREQUIRED

  When the event occurred.

• offset string

  An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

• processed stringREQUIRED

  When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

• type stringREQUIRED

  Possible values: ATTRIBUTE_OPERATION

• user object<User>

  The current state of the user when the event is emitted, including the contact ID and an optional named user ID.

Close

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
    },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
    }
  },
  "user": {
    "contact_id": "982B35f2-0375-6384-893e-a19b5cd5R771"
  },
  "body": {
    "session_id": "61acb6c9-527b-4632-b789-a3e6085b094e"
  },
  "type": "CLOSE"
}

Occurs when a user closes the app. Close events are often latent, as they aren’t sent back to Airship until the user activates the app again.

• body objectREQUIRED
  OBJECT PROPERTIES
  • session_id string

    Represents the “session” of user activity. Absent if the application was initialized while backgrounded.

• device object<App device information>REQUIRED

  Information about app users generated by the SDK.

• id stringREQUIRED

  Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

• occurred stringREQUIRED

  When the event occurred.

• offset string

  An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

• processed stringREQUIRED

  When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

• type stringREQUIRED

  Possible values: CLOSE

• user object<User>

  The current state of the user when the event is emitted, including the contact ID and an optional named user ID.

Contact change

{
  "id": "fe882bd1-e0b9-11ea-bc35-0242f70dd9ff",
  "offset": "1000076075647",
  "occurred": "2024-09-25T19:03:13.903Z",
  "processed": "2024-09-25T19:03:14.426Z",
  "user": {
    "contact_id": "6b5ca2a2-c1f1-4119-9617-2d5bff0db09d",
    "named_user_id": "mini_me"
  },
  "device": {
    "ios_channel": "1ef235f0-03d5-1384-893e-a19b5cd0d110",
    "channel": "1ef235f0-03d5-1384-893e-a19b5cd0d110",
    "device_type": "IOS"
  },
  "body": {
    "change_type": "DISSOCIATION",
    "contact_id": "6b5ca2a2-c1f1-4119-9617-2d5bff0db09d",
    "named_user_id": "mini_me",
    "channel_id": "1ef235f0-03d5-1384-893e-a19b5cd0d110",
  },
  "type": "CONTACT_CHANGE"
}

Occurs when a contact is uninstalled, associated with a channel or Named User, or dissociated from a channel or Named User.

• body object
  OBJECT PROPERTIES
  • change_type string

    Describes the reason the contact change event was emitted.

    • ASSOCIATION: The contact was associated to a channel or Named User.
    • DISSOCIATION: The contact was dissociated from a channel or Named User.
    • UNINSTALL: The contact was uninstalled.

    Possible values: ASSOCIATION, DISSOCIATION, UNINSTALL

  • channel_id string

    The ID of the channel that was associated or dissociated from the contact, depending on the change event type.

  • contact_id string

    The ID of the contact related to the change event.

  • named_user_id string

    An optional string that represents the Named User ID related to the change event.

• device object<App device information>

  Information about app users generated by the SDK.

• id string

  Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

• occurred string

  When the event occurred.

• offset string

  An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

• processed string

  When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

• type string

  Possible values: CONTACT_CHANGE

• user object<User>

  The current state of the user when the event is emitted, including the contact ID and an optional named user ID.

Control

{
  "id" : "ff76bb85-74bc-4511-a3bf-11b6117784db",
  "type": "CONTROL",
  "offset": "MTIzNQ",
  "occurred": "2015-05-03T02:32:12.088Z",
  "processed": "2015-05-03T12:12:43.180Z",
  "device": {
      "channel":"a61448e1-be63-43ee-84eb-19446ba743f0",
      "device_type":"ANDROID",
      "android_channel": "a61448e1-be63-43ee-84eb-19446ba743f0"
    },
  "user": {
      "contact_id": "6b5ca2a2-c1f1-4119-9617-2d5bff0db09d",
      "named_user_id": "mini_me"
    },
  "body:" {
    "push_id": "c91d9e1b-605f-4bad-a45d-cdf3e6e0773f",
    "group_id": "3eec7de4-4b19-436e-ad15-88278f9ddb82"
    }
  }

Occurs when a device is excluded from a push because it was arbitrarily selected as a member of a control group for a Message A/B test, Sequence A/B test, or Holdout Experiment.

• body objectREQUIRED
  OBJECT PROPERTIES
  • campaigns object

    An object listing the campaigns a push specification is associated with. The campaigns object includes an array of categories that must have between 1 and 10 elements, each of which is a string with a 64-byte and -character limit.

    OBJECT PROPERTIES
    • categories array[string]
  • experiment_id string

    The unique identifier for the Message A/B test or Holdout Experiment.

  • group_id string

    Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

  • push_id string

    A unique identifier for a push operation.

• device objectREQUIRED
  One of
  • Appdevices

    Information about app users generated by the SDK.

  • Webdevices

    Information about web users generated by the SDK.

• experiment_id string

  The unique identifier for the Message A/B test or Holdout Experiment.

• id stringREQUIRED

  Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

• occurred stringREQUIRED

  When the event occurred.

• offset string

  An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

• processed stringREQUIRED

  When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

• type stringREQUIRED

  Possible values: CONTROL

• user object<User>

  The current state of the user when the event is emitted, including the contact ID and an optional named user ID.

Custom

{
  "id": "4f42e8d0-a010-11ee-ae53-000000a91ace",
  "offset": "1009810398823",
  "occurred": "2023-12-21T14:50:35.077Z",
  "processed": "2023-12-21T14:50:40.843Z",
  "device": {
    "android_channel": "ac1960b9-24b6-4851-b907-b9e64f071890",
    "channel": "ac1960b9-24b6-4851-b907-b9e64f071890",
    "device_type": "ANDROID",
    "named_user_id": "c2cbc6e5145763ec58a4d85dfa4323aacc40afea",
    "attributes": {
      "locale_variant": "",
      "device_model": "M2101K9G",
      "app_version": "18.4.2",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "Europe/Paris",
      "push_opt_in": "true",
      "locale_country_code": "FR",
      "device_os": "12",
      "locale_timezone": "3600",
      "locale_language_code": "fr",
      "background_push_enabled": "true",
      "ua_sdk_version": "16.9.2"
    }
  },
  "body": {
    "name": "purchased",
    "value": 239.85,
    "transaction": "886f53d4-3e0f-46d7-930e-c2792dac6e0a",
    "interaction_id": "your.store/us/en_us/pd/shoe/pid-11046546/pgid-10978234",
    "interaction_type": "url",
    "properties": {
      "description": "Sneaker purchase",
      "brand": "Victory Sneakers",
      "colors": [
        "red",
        "blue"
      ],
      "items": [
        {
          "text": "New Line Sneakers",
          "price": "$ 79.95"
        },
        {
          "text": "Old Line Sneakers",
          "price": "$ 79.95"
        },
        {
          "text": "Blue Line Sneakers",
          "price": "$ 79.95"
        }
      ],
      "name": "Hugh Manbeing",
      "userLocation": {
        "state": "CO",
        "zip": "80202"
      }
    }
  },
  "session_id": "adc0e12e-dfe8-4375-8121-5b21dbab87f4",
  "source": "SDK",
  "type": "CUSTOM"
}

{
  "id": "4f42e8d0-a010-11ee-ae53-000000a91ace",
  "offset": "1009810398823",
  "occurred": "2023-12-21T14:50:35.077Z",
  "processed": "2023-12-21T14:50:40.843Z",
  "device": {
    "android_channel": "ac1960b9-24b6-4851-b907-b9e64f071890",
    "channel": "ac1960b9-24b6-4851-b907-b9e64f071890",
    "device_type": "ANDROID",
    "named_user_id": "c2cbc6e5145763ec58a4d85dfa4323aacc40afea",
    "attributes": {
      "locale_variant": "",
      "device_model": "M2101K9G",
      "app_version": "18.4.2",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "Europe/Paris",
      "push_opt_in": "true",
      "locale_country_code": "FR",
      "device_os": "12",
      "locale_timezone": "3600",
      "locale_language_code": "fr",
      "background_push_enabled": "true",
      "ua_sdk_version": "16.9.2"
    }
  },
  "body": {
    "name": "purchased",
    "value": 239.85,
    "transaction": "886f53d4-3e0f-46d7-930e-c2792dac6e0a",
    "interaction_id": "your.store/us/en_us/pd/shoe/pid-11046546/pgid-10978234",
    "interaction_type": "url",
    "properties": {
      "description": "Sneaker purchase",
      "brand": "Victory Sneakers",
      "colors": [
        "red",
        "blue"
      ],
      "items": [
        {
          "text": "New Line Sneakers",
          "price": "$ 79.95"
        },
        {
          "text": "Old Line Sneakers",
          "price": "$ 79.95"
        },
        {
          "text": "Blue Line Sneakers",
          "price": "$ 79.95"
        }
      ],
      "name": "Hugh Manbeing",
      "userLocation": {
        "state": "CO",
        "zip": "80202"
      }
    }
  },
  "session_id": "adc0e12e-dfe8-4375-8121-5b21dbab87f4",
  "source": "SDK",
  "type": "CUSTOM"
}

{
  "name" : "shoe-purchase",
  "value" : 239.85,
  "source": "api",
  "transaction" : "Selling all the shoes",
  "session_id": "cfe467a6-ca70-40dd-8c1f-07b2f644935e",
  "properties": {
    "description": "Sneaker purchase",
    "brand": "Victory Sneakers",
    "colors": ["red","blue"],
    "items": [
      {
          "text": "New Line Sneakers",
          "price": "$ 79.95"
      },
      {
          "text": "Old Line Sneakers",
          "price": "$ 79.95"
      },
      {
          "text": "Blue Line Sneakers",
          "price": "$ 79.95"
      }
    ],
    "name": "Hugh Manbeing",
    "userLocation": {
      "state": "CO",
      "zip": "80202"
    }
  }
}

{
  "id": "4f42e8d0-a010-11ee-ae53-000000a91ace",
  "offset": "1009810398823",
  "occurred": "2023-12-21T14:50:35.077Z",
  "processed": "2023-12-21T14:50:40.843Z",
  "device": {
    "android_channel": "ac1960b9-24b6-4851-b907-b9e64f071890",
    "channel": "ac1960b9-24b6-4851-b907-b9e64f071890",
    "device_type": "ANDROID",
    "named_user_id": "c2cbc6e5145763ec58a4d85dfa4323aacc40afea",
    "attributes": {
      "locale_variant": "",
      "device_model": "M2101K9G",
      "app_version": "18.4.2",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "Europe/Paris",
      "push_opt_in": "true",
      "locale_country_code": "FR",
      "device_os": "12",
      "locale_timezone": "3600",
      "locale_language_code": "fr",
      "background_push_enabled": "true",
      "ua_sdk_version": "16.9.2"
    }
  },
  "body": {
    "name": "purchased",
    "value": 239.85,
    "transaction": "886f53d4-3e0f-46d7-930e-c2792dac6e0a",
    "interaction_id": "your.store/us/en_us/pd/shoe/pid-11046546/pgid-10978234",
    "interaction_type": "url",
    "properties": {
      "description": "Sneaker purchase",
      "brand": "Victory Sneakers",
      "colors": [
        "red",
        "blue"
      ],
      "items": [
        {
          "text": "New Line Sneakers",
          "price": "$ 79.95"
        },
        {
          "text": "Old Line Sneakers",
          "price": "$ 79.95"
        },
        {
          "text": "Blue Line Sneakers",
          "price": "$ 79.95"
        }
      ],
      "name": "Hugh Manbeing",
      "userLocation": {
        "state": "CO",
        "zip": "80202"
      }
    }
  },
  "session_id": "adc0e12e-dfe8-4375-8121-5b21dbab87f4",
  "source": "SDK",
  "type": "CUSTOM"
}

{
  "name" : "shoe-purchase",
  "value" : 239.85,
  "source": "api",
  "transaction" : "Selling all the shoes",
  "session_id": "cfe467a6-ca70-40dd-8c1f-07b2f644935e",
  "properties": {
    "description": "Sneaker purchase",
    "brand": "Victory Sneakers",
    "colors": ["red","blue"],
    "items": [
      {
          "text": "New Line Sneakers",
          "price": "$ 79.95"
      },
      {
          "text": "Old Line Sneakers",
          "price": "$ 79.95"
      },
      {
          "text": "Blue Line Sneakers",
          "price": "$ 79.95"
      }
    ],
    "name": "Hugh Manbeing",
    "userLocation": {
      "state": "CO",
      "zip": "80202"
    }
  }
}

{
  "name" : "shoe-purchase",
  "value" : 60.000000,
  "source": "sdk",
  "interaction_type" : "Landing Page",
  "interaction_id" : "d01d0380-da2e-11e3-8519-90e2ba299b38",
  "customer_id" : "George@example.com",
  "transaction" : "Selling all the shoes",
  "session_id": "cfe467a6-ca70-40dd-8c1f-07b2f644935e",
  "last_delivered": {
    "push_id": "6e3339ce-529c-42e4-a2f6-7546f81c9828"
  },
  "triggering_push": {
    "push_id": "c2f6c5c5-f353-49c0-b5f7-6e87cf9b1a06",
    "group_id": "8ea2abd6-dbc7-475a-9c57-fb31c7e2999b"
  },
  "properties": {
    "coolest-identifier": "123-cool-cat-321",
    "ltv": false,
    "category": "womens_shoes",
    "id": 1267,
    "description": "plaid canvas",
    "brand": "hipster",
    "new_item": true
  }
}

Represents Custom Events that are either emitted from the Airship SDK or submitted through the Custom Events API. You can configure Custom Events yourself. There are also several CUSTOM-type events for email and SMS that are defined by Airship.

In general, you can expect device information if the event source is SDK or if the event is one of the defined email or SMS events (as defined by event_type).

• OBJECT PROPERTIES
  • id stringREQUIRED

    Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

  • occurred stringREQUIRED

    When the event occurred.

  • offset stringREQUIRED

    An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

  • processed stringREQUIRED

    When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

  • type stringREQUIRED

    Possible values: CUSTOM

• One of
  • Email Delivery Event

    Occurs when the remote MTA (email server) acknowledges receipt of a message.

  • Email Injection Event

    This event occurs when the provider (SparkPost) receives a message — typically when a member of the audience responds to an email.

  • Email Open Event

    Occurs when a recipient opens an email, rendering a tracking pixel at the bottom of the message. If a message is truncated by a client or email provider, a user may have to open it in a separate window to render the tracking pixel (and register this event).

  • Email Delay Event

    Occurs when a mailbox provider temporarily rejects an email. In general, this event indicates that the provider will attempt to resend the message.

  • Email Bounce Event

    Occurs when an email could not be delivered to an address. The bounce_class provides additional information about the reason your message bounced. This event occurs in conjunction with a similar COMPLIANCE event.

  • Email Click Event

    Occurs when a recipient clicks a tracked link in a message. Tracked links are redirected through the provider’s click-tracking server to record the event. Only HTTP and HTTPS links are tracked. Unsubscribe link clicks do not trigger this event.

  • Email Unsubscribe Link Event

    Occurs when a user clicks an unsubscribe link in an email you sent.

  • Delivery_report

    Delivery reports are Custom Events sent from our third-party SMS providers. These events report the status of your message between the provider and your audience up to, and including, delivery.

  • Rcs_read_report

    Read reports are Custom Events sent when an RCS message is marked as read. These events use the delivery_report interaction type with a name of read. See RCS branded senders.

  • General Custom Event object
    OBJECT PROPERTIES
    • body objectREQUIRED
      OBJECT PROPERTIES
      • customer_id string

        An external customer-side ID, such as an email address. Absent if empty.

      • interaction_id string

        An Airship identifier uniquely identifying the interaction. May be absent.

      • interaction_type string

        The type of interaction as set by the Airship SDK. Values determine whether the interaction triggered an event from the Message Center (ua_mcrap), a landing page (ua_landing_page), an interactive notification (ua_interactive_notification), or a button tap (ua_button_tap).

        Button tap events with custom names are in the format ua_button_tap-<custom name>. For example, for a button action with custom name Cat socks55, the event name is ua_button_tap-Cat socks55. See Buttons and images: App in Actions in the WYSIWYG editor.

        Possible values: ua_mcrap, ua_landing_page, ua_interactive_notification, ua_button_tap, ua_button_tap-<custom name>

      • last_delivered object

        Identifies the last push notification the audience received before the event. Absent if the last push occurred more than 12 hours ago.

        OBJECT PROPERTIES
        • campaigns object

          An object listing the campaigns a push specification is associated with. The campaigns object includes an array of categories that must have between 1 and 10 elements, each of which is a string with a 64-byte and -character limit.

          OBJECT PROPERTIES
          • categories array[string]
        • group_id string

          Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

        • push_id stringREQUIRED

          A unique identifier for a push operation.

        • time string

          The UTC time when the push occurred.

        • variant_id integer

          The ID of the variant that a push is associated with, if the push was a part of an A/B test (experiment).

      • name stringREQUIRED

        A plain-text name given to the event.

      • properties object

        Supports up to 100 key/value pairs that describe Custom Event properties. If the event has no custom properties, this field is absent.

      • session_id string

        Represents the “session” of user activity. Absent if the application was initialized while backgrounded.

      • source stringREQUIRED

        The event source. SDK indicates an event sent from the Airship SDK. API indicates an event created by request against the Custom Events API.

        Possible values: SDK, API

      • transaction string

        If the event is one in a series representing a single transaction, use the value in this field to tie events together.

      • triggering_push object<Associated push>

        The push that caused the Custom Event. Absent if a causal relationship to a push cannot be established.

        The specific push_id and accompanying identifiers associated with an event. An associated push helps you trace an event to the original notification or operation.

        An associated push object may specify a time, if the push was a singular operation sent at a defined time. Otherwise, the object will include a group_id if the push was sent at a relative time (best_time or local_time) an automation pipeline, or another operation resulting in multiple push_ids.

      • value number

        Populated if the event is associated with a count or amount. Airship treats this field as a representation of money. The value field respects six digits of precision to the right of the decimal point.

    • device objectREQUIRED

      Device information related to the event. Either the channel or named_user_id is required. The named_user_id is required for Custom Events sent via the API, else channel is required.

      OBJECT PROPERTIES
      • channel stringREQUIRED

        The unique, platform-agnostic channel identifier for a device.

      • device_type stringREQUIRED

        The type of device the event was generated from.

        Possible values: OPEN, WEB, ANDROID, IOS, AMAZON, EMAIL, SMS

      • named_user_id string

        The Named User identifier for a device.

Feature Flag interaction event

{
  "id":"c3d0543b-c8cd-4eaa-8fda-5dbfa70257ae",
  "offset":"1000197715722",
  "occurred":"2023-09-15T19:12:56.000Z",
  "processed":"2023-09-21T23:02:39.419Z",
  "device": {
    "channel":"8c36e8c7-5a73-47c0-9716-99fd3d4197d5",
    "device_type":"WEB"
  },
  "body": {
    "flag_id":"27f26d85-0550-4df5-85f0-7022fa7a5925",
    "flag_name":"rad_flag_name",
    "eligible":true
  },
  "type":"FEATURE_FLAG_INTERACTION"
}

Occurs when a user interacts with a tracked flagged feature. See Feature Flags. The events have a flag ID and flag name, which identify which flagged feature a user interacted with. They also have a boolean eligible field, which indicates whether or not the user was in the Feature Flag audience and had access to the feature.

• body objectREQUIRED
  OBJECT PROPERTIES
  • eligible booleanREQUIRED

    Indicates whether or not the user was in the Feature Flag audience and had access to the feature. true means the user was in the Feature Flag audience and had access to the feature.

  • flag_id stringREQUIRED

    A UUID that is associated with a feature flag.

  • flag_name stringREQUIRED

    The name of a feature flag.

  • variant_id string

    The UUID of the A/B test variant, if available.

• device objectREQUIRED
  One of
  • Appdevices

    Information about app users generated by the SDK.

  • Webdevices

    Information about web users generated by the SDK.

• id stringREQUIRED

  Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

• occurred stringREQUIRED

  When the event occurred.

• offset string

  An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

• processed stringREQUIRED

  When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

• type stringREQUIRED

  Possible values: FEATURE_FLAG_INTERACTION

First open

{
  "device": {
    "ios_channel": "1ef235f0-03d5-1384-893e-a19b5cd0d110",
    "channel": "1ef235f0-03d5-1384-893e-a19b5cd0d110",
    "device_type": "IOS",
  },
  "id": "00000169-4a14-67b2-1ddd-d9e733622c3a",
  "occurred": "2019-03-04T19:00:45.106Z",
  "offset": "1000001260057",
  "processed": "2019-03-04T19:00:47.094Z",
  "type": "FIRST_OPEN"
}

This event occurs when a user opens an Airship-integrated app for the first time.

• device objectREQUIRED
  One of
  • Appdevices

    Information about app users generated by the SDK.

  • Webdevices

    Information about web users generated by the SDK.

• id stringREQUIRED

  Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

• occurred stringREQUIRED

  When the event occurred.

• offset string

  An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

• processed stringREQUIRED

  When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

• type stringREQUIRED

  Possible values: FIRST_OPEN

First opt-in

{
  "device": {
    "channel": "820e4493-e4c9-4577-99bc-a98180599f73",
    "delivery_address": "new.user@urbanairship.com",
    "device_type": "EMAIL"
  },
  "id": "00000169-4a14-67b2-1ddd-d9e733622c3a",
  "occurred": "2019-03-04T19:00:45.106Z",
  "offset": "1000001260057",
  "processed": "2019-03-04T19:00:47.094Z",
  "type": "FIRST_OPT_IN"
}

This event appears in the stream when a channel is first opted in. This event is specific to email (commercial), SMS, and open channels.

• device objectREQUIRED
  One of
  • Sms_email_devices

    Information about the SMS or email device related to an event.

  • Opendevices

    Information about open channel users.

• id stringREQUIRED

  Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

• occurred stringREQUIRED

  When the event occurred.

• offset string

  An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

• processed stringREQUIRED

  When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

• type stringREQUIRED

  Possible values: FIRST_OPT_IN

In-app button tap

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "push_id": "a9a5912c-2526-4383-b516-711c58aff900",
      "group_id": "a9a5912c-2526-4383-b516-711c58aff900",
      "session_id": "94e8caed-9b82-4166-b585-a01eed933855",
      "triggering_push": {
        "push_id": "a183f051-7d69-11ed-86d9-0242dc3f670b",
        "group_id": "8e7cfac3-cfd3-4f4f-a9a1-d766de9b063a",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      },
      "context": {
        "reporting_context": {
          "content_types": [
            "survey"
          ]
        },
        "state": {
          "form": {
            "form_identifier": "870db95f-3715-4c98-8047-2871c175d003",
            "submitted": true,
            "type": "nps",
            "response_type": "nps"
          },
          "pager": {
            "identifier": "9e051354-185b-4d4d-888a-885def2e6b7a",
            "page_identifier": "32f4fc47-74ee-41c6-8e16-c9e0aa364101",
            "page_index": 1,
            "page_count": 2,
            "completed": true
          }
        }
      },
      "button_id": "dismiss_button"
    },
  "type": "IN_APP_BUTTON_TAP"
}

Occurs when a button is tapped within a Scene.

• body objectREQUIRED
  OBJECT PROPERTIES
  • app_defined_id string

    An identifier defined by the application if the in-app button tap was created by the application logic, not Airship. If this field is present, the event body will not contain push_id, group_id, variant_id, or triggering_push fields.

  • button_id string

    A unique identifier for the button.

  • context object<In-app context>

    The context provides the view state when a button, pager, or form interaction occurs.

  • group_id string

    Identifies a push specification delivered over an interval of time, e.g., multiple push_ids as part of the fulfillment of an automation pipeline or a push-to-local-time specification.

  • locale string

    Optional string that defines the country and language this in-app-automation was localized as by remote-config-api. country - (String) An ISO 3166-1 country code, set by device settings. language - (String) The ISO 639-1 two-letter language code reflecting the language the phone is set to.

  • push_id string

    A unique identifier for a push operation.

  • session_id string

    Represents the “session” of user activity. Absent if the application was initialized while backgrounded.

  • time_sent string

    An ISO 8601 date-time indicating when the payload defining the in-app message was sent to the device. May be absent.

  • triggering_push object<Associated push>

    Appears if the user began the current session by opening a push notification.

    The specific push_id and accompanying identifiers associated with an event. An associated push helps you trace an event to the original notification or operation.

    An associated push object may specify a time, if the push was a singular operation sent at a defined time. Otherwise, the object will include a group_id if the push was sent at a relative time (best_time or local_time) an automation pipeline, or another operation resulting in multiple push_ids.

• device object<App device information>REQUIRED

  Information about app users generated by the SDK.

• id stringREQUIRED

  Uniquely identifies an event. The data stream will occasionally send duplicate events. Duplicate events will have the same id, type, occurred, device, and body values but different offset and processed values. You should use the id to deduplicate.

• occurred stringREQUIRED

  When the event occurred.

• offset string

  An identifier of a location in the stream; used to resume the stream after severing a connection. If you open a stream using the offset value, the stream will resume with the next element in the stream. You should store this value as a string so that you can easily resume the stream if it ends for any reason.

• processed stringREQUIRED

  When the event was ingested by Airship. There may be some latency between when the event occurred, and when it was processed.

• type stringREQUIRED

  Possible values: IN_APP_BUTTON_TAP

• user object<User>

  The current state of the user when the event is emitted, including the contact ID and an optional named user ID.

In-app experiences

{
  "id": "51dd7c1c-5621-11e9-9601-0242539d70ef",
  "offset": "1000022467557",
  "occurred": "2019-03-29T21:42:21.245Z",
  "processed": "2019-04-03T15:10:23.828Z",
  "device": {
    "ios_channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "channel": "a61448e1-be63-43ee-84eb-19446ba743f0",
    "device_type": "IOS",
    "named_user_id": "cooluser",
    "identifiers": {
      "com.urbanairship.limited_ad_tracking_enabled": "true",
      "session_id": "B147E0CE-272E-4047-A79C-30D02A2F213D",
      "GA_CID": "a61448e1-be63-43ee-84eb-19446ba743f0",
      "com.urbanairship.idfa": "A76E6F83-4F4A-47E2-BFDD-72BED91D2D1F",
      "com.urbanairship.vendor": "ED496B1A-43F1-45A9-A7C1-80125DE8A5B1"
      },
    "attributes": {
      "locale_variant": "",
      "app_version": "542",
      "device_model": "iPhone7,2",
      "app_package_name": "com.company_name.app_name",
      "iana_timezone": "America/Los_Angeles",
      "push_opt_in": "true",
      "locale_country_code": "US",
      "device_os": "11.4",
      "locale_timezone": "-25200",
      "locale_language_code": "en",
      "location_enabled": "false",
      "background_push_enabled": "true",
      "ua_sdk_version": "10.2.0",
      "location_permission": "ALWAYS_ALLOWED"
      }
    },
    "body": {
      "event_name": "scene_displayed",
      "time_sent": "2022-03-11T08:40:56.592Z",
      "session_id": "20162c5f-36c8-1808-6fc6-8eb836d7f7f2",
      "push_id": "2e12bc7b-04f2-3487-1480-44269b04c131",
      "group_id": "2e12bc7b-04f2-3487-1480-44269b04c131",
      "triggering_push": {
        "push_id": "5cc872d5-708d-dffb-0959-991b014dcd2d",
        "time": "2022-03-11T08:40:56.692Z",
        "campaigns": {
          "categories": [
            "welcome_series"
          ]
        }
      }
    },
  "type": "IN_APP_EXPERIENCES"
}