Skip to content

CustomEvent.md

Latest commit

 

History

History
26 lines (20 loc) · 1 KB

CustomEvent.md

File metadata and controls

26 lines (20 loc) · 1 KB

OneSignal::CustomEvent

Properties

Name Type Description Notes
name String The identifier or name of the event. Maximum 128 characters.
external_id String The external ID of the user targeted for the event. Either the user's External ID or OneSignal ID is required. [optional]
onesignal_id String The OneSignal ID of the user targeted for the event. Either the user's External ID or OneSignal ID is required. [optional]
timestamp Time Time the event occurred as an ISO8601 formatted string. Defaults to now if not included or past date provided. [optional]
payload Hash<String, Object> Properties or data related to the event, like {&quot;geography&quot;: &quot;USA&quot;} [optional]

Example

require 'onesignal'

instance = OneSignal::CustomEvent.new(
  name: null,
  external_id: null,
  onesignal_id: null,
  timestamp: null,
  payload: null
)