Property name | Type | Description |
---|---|---|
id | int | ID of the event. Generated automatically by the server after event creation. |
notification_channel | nested object | Declare which notification channels could be used to notify user about events. |
notification_channel.name | string | Notification channel name. Possible values are: apns , apns_voip , gcm , and email . |
event_type | string | Event type. Possible values are: - one_shot - a one-time event caused by an external object (valid only if the date is not specified).- fixed_date - a one-time event that occurs at a specified date (valid only if the date is specified).- period_date - is a reusable event that occurs within a given period from the initial date (valid only if the period is specified).Default: - one_shot - if date is not specified.- fixed_date - if date is specified.- period_date - if period is specified. |
message | string | Encoded message payload. Possible values are: Base64 encoded plain text or push notification payload (Push notifications formats). |
date | int | The date when event should be sent. If event_type=fixed_date , value of date can not be in the past. |
period | int | A period of the event in seconds. |
name | string | A name of the event. Service information. Only for your own usage. |
occured_count | int | A number of times the event was sent. |
created_at | datetime | Date & time when a record was created, filled automatically. |
updated_at | datetime | Date & time when a record was updated, filled automatically. |
end_date | int | A date when the event was completed. Must be not less than the date . |
active | boolean | Marks the event as active/inactive. |
application_id | int | ID of the application. |
user_id | int | ID of the user who created the event. |
kind | string | Kind of the event. Possible values are: API , DashBoard , and ChatAlert . |
environment | string | An environment of the notification. Possible values are: development and production . |
tag_query | string | Select event recipients by tags. |