v26

latestOpenAPI 3.0.0raw.githubusercontent.com2023-06-09375890.9 KB

Event

Register an event

Event Types:

type	description
re.notifica.event.application.Install	Stored whenever a new device installs the app.
re.notifica.event.application.Registration	Stored whenever a new device is registered.
re.notifica.event.application.Uninstall	Stored whenever an app was removed from the device, as reported by APNS, GCM or HMS feedback.
re.notifica.event.application.Upgrade	Stored whenever we detect a new app version.
re.notifica.event.application.Open	Stored whenever the application becomes active.
re.notifica.event.application.Close	Stored whenever the application goes to background.
re.notifica.event.application.Exception	Stored whenever the application encounters an exception.
re.notifica.event.notification.Sent	Stored whenever a notification is sent.
re.notifica.event.notification.Receive	Stored whenever a notification arrives.
re.notifica.event.notification.Open	Stored whenever a notification is open.
re.notifica.event.notification.Influenced	Stored whenever a notification is open when app is not active.
re.notifica.event.push.Registration	Stored whenever a device is registered with an APNS/FCM token (SDK v3 and up).
re.notifica.event.inappmessage.View	Stored whenever an in-app message is viewed.
re.notifica.event.inappmessage.Action	Stored whenever an in-app message action is executed.
re.notifica.event.region.Session	Stored whenever a user enters and leaves a region.
re.notifica.event.beacon.Session	Stored whenever a user is on the proximity of a beacon.
re.notifica.event.scannable.Scan	Stored whenever a Scannable tag is scanned.
re.notifica.event.link.Click	Stored whenever a Link is clicked.
re.notifica.event.pass.Add	Stored whenever a pass is added to a device's wallet.
re.notifica.event.pass.Remove	Stored whenever a pass is removed from a device's wallet.
re.notifica.event.pass.Redeem	Stored whenever a pass is redeemed.
re.notifica.event.product.Buy	Stored 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.asset.Load	Stored whenever an Asset Group is loaded.
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