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)​

AttributesTypeRequiredDescription
titlestringyesA title of a web push message.
bodystringyesA content of a web push message.
urlstringnoA URL of a web push message.
require_interactionbooleannoA flag defining if a notification should remain active until the user clicks or dismisses it, rather than closing automatically.
doughnut_titlestringnoAction button 1 label.
doughnut_urlstringnoAction button 1 URL.
coffee_titlestringnoAction button 2 label.
coffee_urlstringnoAction button 2 URL.
iconstringnoA URL of image inside a web push message.
badgestringnoA 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 fieldTypeDescription
idintegerUnique identifier for the message variant.
namestringMessage variant name (e.g. "A").
message_idintegerInternal message identifier.
message_titlestringTitle of the web push message.
message_bodystringBody text of the web push message.
message_badgestringBadge image URL, or null.
message_iconstringIcon image URL, or null.
message_urlstringClick-through URL of the notification.
message_require_interactionbooleanWhether the notification requires user interaction.
message_doughnut_titlestringAction button 1 label.
message_doughnut_urlstringAction button 1 URL.
message_actionsbooleanWhether action buttons are configured.
message_coffee_titlestringAction button 2 label.
message_coffee_urlstringAction button 2 URL.