Skip to main content

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

titlestringrequired
A title of a web push message.
bodystringrequired
A content of a web push message.
urlstring
A URL of a web push message.
require_interactionboolean
A flag defining if a notification should remain active until the user clicks or dismisses it, rather than closing automatically.
doughnut_titlestring
Action button 1 label.
doughnut_urlstring
Action button 1 URL.
coffee_titlestring
Action button 2 label.
coffee_urlstring
Action button 2 URL.
iconstring
A URL of image inside a web push message.
badgestring
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

idinteger
Unique identifier for the message variant.
namestring
Message variant name (e.g. "A").
message_idinteger
Internal message identifier.
message_titlestring
Title of the web push message.
message_bodystring
Body text of the web push message.
message_badgestring
Badge image URL, or null.
message_iconstring
Icon image URL, or null.
message_urlstring
Click-through URL of the notification.
message_require_interactionboolean
Whether the notification requires user interaction.
message_doughnut_titlestring
Action button 1 label.
message_doughnut_urlstring
Action button 1 URL.
message_actionsboolean
Whether action buttons are configured.
message_coffee_titlestring
Action button 2 label.
message_coffee_urlstring
Action button 2 URL.