Event

Register an event

Event Types:

typedescription
re.notifica.event.application.InstallStored whenever a new device installs the app.
re.notifica.event.application.UninstallStored whenever an app was removed from the device, as reported by APNS, GCM or HMS feedback.
re.notifica.event.application.OpenStored whenever the application becomes active.
re.notifica.event.application.CloseStored whenever the application goes to background.
re.notifica.event.notification.InfluencedStored whenever a notification when app is not active.
re.notifica.event.notification.ReceiveStored whenever a notification arrives.
re.notifica.event.notification.OpenStored whenever a notification is open.
re.notifica.event.region.SessionStored whenever a user enters and leaves a region.
re.notifica.event.beacon.SessionStored whenever a user is on the proximity of a beacon.
re.notifica.event.pass.AddStored whenever a pass is added to a device's wallet.
re.notifica.event.pass.RemoveStored whenever a pass is removed from a device's wallet.
re.notifica.event.pass.RedeemStored whenever a pass is redeemed.
re.notifica.event.product.BuyStored whenever a purchase is done.
re.notifica.event.product.Buy.{store}Stored whenever a purchase is done, where store is AppStore or GooglePlay.
re.notifica.event.product.Buy.{store}.{identifier}Stored whenever a purchase is done, where store is AppStore or GooglePlay.
re.notifica.event.custom.{name}Any other event stored by your application.
post/event

Request body

typestring

A reverse domain style namespace that identifies the type of event.

deviceIDstring

The unique identifier for your device corresponding to the APNS, FCM or Webpush token.

sessionIDstring

The session identifier that allows to cross reference events.

userIDstring

The app-defined user identifier that you can use to send messages to this user.

notificationstring
{"stackTrail":"components:schemas:EventCreate:properties:data","oasType":"schema","type":"unknown","description":"A free form object that allows you to store any type of data for an event.","example":{"campaignID":"12526dd66d666d66772d"}}

Example request

{
  "type": "re.notifica.event.application.Open",
  "deviceID": "APA91bEpai_9PbfvVie3xvVnM2VXZEjQ1ZZIFiRzXf",
  "sessionID": "1627576d6d6d66d676627",
  "userID": "1234567890",
  "notification": "1d9e80ef851d212aca82cf23",
  "data": {
    "campaignID": "12526dd66d666d66772d"
  }
}

Response

Accepted

Changes