Manage Event Properties

Add properties from custom events that you want to use as filters for automation rules and journeys using custom event triggers.

Custom Events can contain a body.properties object with information pertinent to an event that happened outside of Airship. You can define these custom event properties in your Airship project configuration to use them as filters for automation rules and journeys using custom event triggersA trigger that initiates an automation or journey when a custom event associated with members of your audience occurs. or cancellation eventsEvents that prevent an automation from sending a message if a custom event occurs while the automation is in a delay period. .

Example Custom Event with Properties

In the following example, the custom event body contains properties for category, id, description, brand, and price. You can add any or all of these properties to Airship as filters for custom events.

[
   {
      "occurred": "2016-05-02T02:31:22",
      "user": {
         "android_channel": "e393d28e-23b2-4a22-9ace-dc539a5b07a8"
      },
      "body": {
         "name": "purchased",
         "value": 120.49,
         "transaction": "886f53d4-3e0f-46d7-930e-c2792dac6e0a",
         "interaction_id": "your.store/us/en_us/pd/shoe/pid-11046546/pgid-10978234",
         "interaction_type": "url",
         "properties": {
            "category": "mens shoes",
            "id": "11046546",
            "description": "sky high",
            "brand": "victory",
            "price": "120.49"
         },
         "session_id": "22404b07-3f8f-4e42-a4ff-a996c18fa9f1"
      }
   }
]

Defining custom event properties on the Settings » Configuration » Event Properties page does not affect custom events that you send to Airship. Defining custom event properties only exposes them as filters for custom event-triggered automation rules and journeys in the Airship UI.

See also:

Add Event Properties

You do not need to define all event properties, only the ones you may want to use as filters for the custom event.

  1. Go to Settings » Configuration » Event Properties.
  2. Click Add Event Properties.
  3. Search for custom events that occurred within the last 30 days, select an event, and click Next. If there are no results for your search, click Use [search term] to use the event name as typed.
  4. (Optional) Enter a description for the event.
  5. Enter a property and select its type. The type determines which operators are available to you in the dashboard. Select Any if the value for the property is unknown or if it could be multiple types.
  6. (Optional) Click Add Another to assign additional properties for the event.
  7. Click Save.

Edit or Delete Event Properties

  1. Go to Settings » Configuration » Event Properties. The table includes a maximum of 1,000 events. Narrow down your list using the Search field.
  2. Click , make your changes, and click Save, or click to delete.
 Note

  • Deleting an event property makes it unavailable for use in new automations and journeys.
  • Deleting the event property from this list does not:
    1. Remove filters based on this property from your existing automations and journeys.
    2. Remove the properties from the event itself.