Webpush message model
You can create a webpush message. These messages will be used in a webpush campaign.
Input fields (Create / Update)
Attributes
Optional unless marked required
- title
- A title of a web push message.
- body
- A content of a web push message.
- url
- A URL of a web push message.
- require_interaction
- A flag defining if a notification should remain active until the user clicks or dismisses it, rather than closing automatically.
- doughnut_title
- Action button 1 label.
- doughnut_url
- Action button 1 URL.
- coffee_title
- Action button 2 label.
- coffee_url
- Action button 2 URL.
- icon
- A URL of image inside a web push message.
- badge
- A URL of image inside a web push message (known as a Big photo). Only works on Windows.
Response fields (GET)
In GET responses, message fields are returned with a message_ prefix:
Response field
- id
- Unique identifier for the message variant.
- name
- Message variant name (e.g. "A").
- message_id
- Internal message identifier.
- message_title
- Title of the web push message.
- message_body
- Body text of the web push message.
- message_badge
- Badge image URL, or
null. - message_icon
- Icon image URL, or
null. - message_url
- Click-through URL of the notification.
- message_require_interaction
- Whether the notification requires user interaction.
- message_doughnut_title
- Action button 1 label.
- message_doughnut_url
- Action button 1 URL.
- message_actions
- Whether action buttons are configured.
- message_coffee_title
- Action button 2 label.
- message_coffee_url
- Action button 2 URL.