Notifications API
You can use the Alexa Notifications REST API to send notifications to your customers.
Notification types
This API can deliver notifications to up to a hundred different units in a single request. You can specify one of the following notification types:
- Device notification – For Alexa-enabled devices without screens, the device notification is a yellow ring and a chime sound. For devices with screens, the device notification is a banner and a persistent notification indicator.
- Announcement – For devices with and without screens, Alexa makes announcements by voice. Devices with screens also display a message on the screen.
- Persistent visual alert – Persistent visual alerts are available for devices with screens. A persistent visual alert is a notification that displays on the screen until it expires or the guest or resident dismisses it. Persistent visual alerts require the premium multimodal add-on subscription. For details, see Premium Multimodal.
API endpoint
In the request header, set Host
to one of the following, depending on the region of your organization:
Country | Endpoint |
---|---|
CA, US |
|
DE, ES, FR, IT, UK |
|
JP |
|
Authentication
Each API request must have an authorization header whose value is the access token retrieved from Login with Amazon (LWA).
Operations
The Notifications API includes the following operations.
Operation | HTTP Method and URI |
---|---|
| |
| |
| |
|
Send notifications
Call POST /v3/notifications
to send notifications to customers.
This operation is available in the following countries.
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
US |
US, UK, FR, CA, IT, DE, ES, JP |
US, UK, FR, CA, IT, DE, ES, JP |
US |
Request format
POST /v3/notifications HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}
Request body examples
The following example shows a device notification.
{
"recipients": [
{
"type": "Unit",
"id": "amzn1.alexa.unit.did.{unitId1}"
},
{
"type": "Unit",
"id": "amzn1.alexa.unit.did.{unitId2}"
}
],
"notification": {
"variants": [
{
"type": "DeviceNotification",
"content": {
"variants": [
{
"type": "SpokenText",
"values": [
{
"locale": "en-US",
"text": "Example notification text."
}
]
}
]
}
}
]
}
}
The following example shows an announcement.
{
"recipients": [
{
"type": "Unit",
"id": "amzn1.alexa.unit.did.{unitId1}"
},
{
"type": "Unit",
"id": "amzn1.alexa.unit.did.{unitId2}"
},
{
"type": "Unit",
"id": "amzn1.alexa.unit.did.{unitId3}"
}
],
"notification": {
"variants": [
{
"type": "Announcement",
"content": {
"variants": [
{
"type": "SpokenText",
"values": [
{
"locale": "en-US",
"text": "Example notification text."
}
]
}
]
}
}
]
}
}
The following example shows a persistent visual alert (requires the premium multimodal add-on).
Request body parameters
Field | Description | Type | Required |
---|---|---|---|
|
The recipient of the notification. |
Array |
Yes |
|
Recipient type. |
Enum |
Yes |
|
The endpoint or unit ID.
Note: The maximum number of unit IDs per request is 100.
|
String |
Yes |
|
The notification object. |
Object |
Yes |
|
The reference ID of the newly created persistent visual alert. The |
String |
No |
|
Notification delivery type. For details about the differences, see Notification types. |
Enum |
Yes |
|
Content for the notification. The specific fields for this object depend on the |
Object |
Yes |
|
The locale-specific notification content to deliver to the unit. |
Array of objects |
Yes |
|
Type of notification. Accepted values
For both types, you provide the notification content within the |
Enum |
Yes |
|
Content values array. Each element in the array represents localized version of the notification. |
Array of objects |
Yes |
|
The locale in which the spoken text is rendered, in IETF BCP 47 format. |
String |
Yes |
|
Spoken text in plain text format. Maximum length is 1024 characters or 2048 bytes. Applies when the notification |
String |
Yes for |
|
Object that defines the APL document to display. Applies when the notification |
Object |
Yes, for |
|
Type of APL document to display. Set to |
String |
Yes, for |
|
Set to one of the four supported APL templates to display:
|
String |
Yes, for |
|
Contains the data for the specified Applies when the notification |
Object |
Yes, for |
|
Object that contains options for how Alexa should deliver the notification. Applies when the notification |
Object |
No |
|
Specifies the sound to play when the notification arrives on the device. |
Enumeration |
No |
|
Specifies how the notification interrupts any existing experience on the device. Accepted values
Defaults to |
Enumeration |
No |
|
An object that determines how to schedule the notification arrival and dismissal times. When not provided, Alexa delivers the notification immediately. Applies when the notification Provide either the |
Object |
No |
|
The date and time when you want the notification to arrive, in ISO 8601 format. |
String |
No |
|
The date and time when you want the notification to expire, in ISO 8601 format. The notification remains on the device until this time, unless the guest or resident dismisses the notification manually. |
String |
No |
|
The date and time of the expiry for the notification, in ISO 8601 format. The notification remains on the device until this time, unless the guest or resident dismisses the notification manually. Applies when the notification Provide either the |
String |
No |
Response header
Host
value is the same as the Host
value in the request.HTTP/1.1 202 Accepted
Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Field | Description | Type |
---|---|---|
|
Unique identifier for the request. If a problem occurs, Amazon can use this value to troubleshoot the problem.. |
String |
Response body examples
The following example shows a response when the notification was sent to all recipients successfully.
{
"type": "ALL_SUCCESS",
"message": "All message published successfully.",
"successResults": [
{
"id": "amzn1.alexa.unit.did.<unitId1>",
"referenceId": "0176a8dd-1f79-4933-a3a4-8e76fc43fd7a"
},
{
"id": "amzn1.alexa.unit.did.<unitId2>",
"referenceId": "475dc098-2319-11ec-9621-0242ac130002"
}
],
"errors": [
]
}
The following example shows a response when the notification failed to send to some of the recipients.
{
"type": "PARTIAL_SUCCESS",
"message": "1 of 3 failed to publish.",
"successResults": [
{
"id": "amzn1.alexa.unit.did.<unitId1>",
"referenceId": "0176a8dd-1f79-4933-a3a4-8e76fc43fd7a"
},
{
"id": "amzn1.alexa.unit.did.<unitId2>",
"referenceId": "475dc098-2319-11ec-9621-0242ac130002"
}
],
"errors": [
{
"id": "amzn1.alexa.unit.did.<unitId3>",
"status": 400,
"errorCode": "Bad Request",
"errorDescription": "Request or recipient ID is malformed."
}
]
}
The following example shows a response when the notification failed to send to all the recipients. The reason for failure could be different for each recipient.
{
"type": "ALL_FAILED",
"message": "All messages failed to publish.",
"successResults": [
],
"errors": [
{
"id": "amzn1.alexa.unit.did.<unitId2>",
"status": 403,
"errorCode": "Forbidden",
"errorDescription": "Request is forbidden."
},
{
"id": "amzn1.alexa.unit.did.<unitId2>",
"status": 400,
"errorCode": "Bad Request",
"errorDescription": "Request or recipient ID is malformed."
},
{
"id": "amzn1.alexa.unit.did.<unitId3>",
"status": 400,
"errorCode": "Bad Request",
"errorDescription": "Unit already has active PersistentVisualAlert."
}
]
}
Response parameters
If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service.
Field | Description | Type |
---|---|---|
|
Short description. |
String |
|
Detailed description of the result. |
String |
|
List of successfully processed units. |
Array |
|
Successfully processed unit ID. |
String |
|
Unique identifier for the unit. If a problem occurs, Amazon can use this value to troubleshoot the problem. |
String |
|
List of unsuccessful unit IDs. |
Array |
|
Unsuccessfully processed unit ID. |
String |
|
Error status. |
Integer |
|
Short error code. |
String |
|
Detailed description of the error for a unit. |
String |
Error response examples
If the action failed as whole, the service sends back an HTTP response other than 202. The following data is returned in JSON format by the service.
{
"type": "Unauthorized",
"message": "HTTP 401 Unauthorized"
}
Error response element
Field | Description | Type |
---|---|---|
|
Short description. |
String |
|
Detailed description of the result. |
String |
HTTP response codes
Status Code | Name | Description |
---|---|---|
202 |
Accepted |
The request is accepted. Status of individual recipient is either inside |
400 |
Bad Request |
The request is malformed or is missing one or more required parameters. |
401 |
Unauthorized |
The access token is missing, expired, or invalid. |
403 |
Forbidden |
The user doesn't have permission to perform the operation. |
429 |
Too many requests |
The request is throttled. |
500 |
Internal Server Error |
The request couldn't be handled because of an internal service error. |
503 |
Service Unavailable |
The server is temporarily unavailable. |
Delete notification by unit ID
Call DELETE /v3/notifications?recipients.id={unitid}&recipients.type=Unit¬ification.variants.type=DeviceNotification
to delete all notifications associated with a unit.
This operation is available in the following countries.
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
US |
US, UK, FR, CA, IT, DE, ES, JP |
US, UK, FR, CA, IT, DE, ES, JP |
US |
Request format
DELETE /v3/notifications?recipients.id={unitid}&recipients.type=Unit¬ification.variants.type=DeviceNotification
Host: api.amazonalexa.com
Content-type: application/json
Authorization: Bearer {LWA Token}
Request path parameters
Field | Description | Type | Required |
---|---|---|---|
|
Unit ID, in the format |
String |
Yes |
|
Recipient type: |
String |
Yes |
|
Notification delivery type. Valid values: |
String |
Yes |
Request body examples
The request has no body.
Request body parameters
The request has no body.
Response header
Host
value is the same as the Host
value in the request.HTTP/1.1 202 Accepted
Host: api.amazonalexa.com
Content-Type: application/json
X-Amzn-RequestId: {request-id}
Response header parameters
Field | Description | Type |
---|---|---|
|
Unique identifier for the request. If a problem occurs, Amazon can use this value to troubleshoot the problem.. |
String |
Response body examples
A successful response doesn't contain a body. Upon successfully receiving a deletion request, the server returns an HTTP 202 OK status response. The server returns this response even if the specified unit doesn't have any of the specified notification type to delete.
Error response examples
If the action failed as whole, the service sends back an HTTP response other than 202. The following data is returned in JSON format by the service.
{
"type": "Unauthorized",
"message": "HTTP 401 Unauthorized"
}
Error response element
Field | Description | Type |
---|---|---|
|
Short description. |
String |
|
Detailed description of the result. |
String |
HTTP response codes
Status Code | Name | Description |
---|---|---|
202 |
Accepted |
The deletion request for the specified unit was accepted. All of the specified notification types for this unit are deleted. |
400 |
Bad Request |
The request is malformed or is missing one or more required parameters. |
401 |
Unauthorized |
The access token is missing, expired, or invalid. |
403 |
Forbidden |
The user doesn't have permission to perform the operation. |
429 |
Too many requests |
The request is throttled. |
500 |
Internal Server Error |
The request couldn't be handled because of an internal service error. |
503 |
Service Unavailable |
The server is temporarily unavailable. |
Delete all notifications
Call POST /v3/notifications/delete
to delete all notifications that are associated with the specified units.
This operation is available in the following countries.
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
US |
US, UK, FR, CA, IT, DE, JP |
US, UK, FR, CA, IT, DE, JP |
US |
Request format
The following example shows how to delete device notifications.
POST /v3/notifications/delete
Host: api.amazonalexa.com
Content-type: application/json
Authorization: Bearer {LWA Token}
Request body examples
{
"recipients" : [
{
"type": "Unit",
"id": "amzn1.alexa.unit.did.{unitId1}"
},
{
"type": "Unit",
"id": "amzn1.alexa.unit.did.{unitId2}"
}
],
"notificationTypes" : ["PersistentVisualAlert"]
}
Request body parameters
Parameter | Description | Type | Required |
---|---|---|---|
|
List of IDs of units or endpoints for which to delete notifications. Minimum size: 1. Maximum size: 100. |
Array |
Yes |
|
Recipient type. |
Enum |
Yes |
|
The endpoint or unit ID.
|
String |
Yes |
|
Type of notification to delete. Valid values: |
Array |
Yes |
Response header
Host
value is the same as the Host
value in the request.HTTP/1.1 202 Accepted
Host: api.amazonalexa.com
Content-Type: application/json
X-Amzn-RequestId: {request-id}
Response header parameters
Field | Description | Type |
---|---|---|
|
Unique identifier for the request. If a problem occurs, Amazon can use this value to troubleshoot the problem. |
String |
Response body examples
A successful response doesn't contain a body. Upon successfully receiving a deletion request, the server returns an HTTP 202 OK status response.
Error response examples
If the action fails as whole, the service sends back an HTTP response other than 202.
For example, when authorization fails with a 401 response code, the following data is returned in JSON format.
{
"type": "Unauthorized",
"message": "The access token is missing, expired, or invalid.",
"errors": []
}
The following example shows the body of a 400 response when a specified unit ID is invalid.
{
"type": "Bad Request",
"message": "Invalid payload format, please check documentation.",
"errors": [{
"id": "amzn1.alexa.unit.did.{unitId1}",
"status": 400,
"errorCode": "Bad Request",
"errorDescription": "Invalid UnitId."
}]
}
The following example shows the body of a 400 response when you're not authorized to operate on one or more unit IDs.
{
"type": "Bad Request",
"message": "Invalid payload format, please check documentation.",
"errors": [{
"id": "amzn1.alexa.unit.did.{unitId1}",
"status": 403,
"errorCode": "Forbidden",
"errorDescription": "User not authorized"
},{
"id": "amzn1.alexa.unit.did.{unitId2}",
"status": 403,
"errorCode": "Forbidden",
"errorDescription": "User not authorized"
},{
"id": "amzn1.alexa.unit.did.{unitId3}",
"status": 403,
"errorCode": "Forbidden",
"errorDescription": "User not authorized"
}]
}
Error response element
Field | Description | Type |
---|---|---|
|
Short description. |
String |
|
Detailed description of the result. |
String |
|
List of unit IDs that failed to process along with the associated error information. |
String |
|
The unit ID that fails to process. |
String |
|
Error status code. |
Integer |
|
Code that indicates the error type. |
String |
|
Error description. |
String |
HTTP response codes
Status Code | Name | Description |
---|---|---|
202 |
Accepted |
The deletion request for a list of units is accepted and being processed. |
400 |
Bad Request |
The request is malformed or is missing one or more required parameters. |
401 |
Unauthorized |
The access token is missing, expired, or invalid. |
429 |
Too many requests |
The request is throttled. |
500 |
Internal Server Error |
The request couldn't be handled because of an internal service error. |
503 |
Service Unavailable |
The server is temporarily unavailable. |
Query persistent visual alerts
To query the persistent visual alerts present in a list of units, call POST /v3/notifications/query
.
This operation is available in the following countries.
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
US |
US, UK, FR, CA, IT, DE, ES, JP |
US, UK, FR, CA, IT, DE, ES, JP |
US |
Request format
POST /v3/notifications/query HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}
Request body format
{
"query": {},
"paginationContext": {
"maxResults": 10,
"nextToken": "paginationTokenString"
}
}
Request parameters
Field | Description | Type | Required |
---|---|---|---|
|
Object that provides filtering conditions. This object has only one allowed field, which can be either The query must adhere to the following rules:
A A |
Object |
Yes |
|
Maximum number of items to return in one request. Minimum value: 1. Maximum value: 100. |
Integer |
No |
|
Token you use to retrieve subsequent data in the previous response, if applicable. This field must either be null or a valid value returned from the server. |
String |
No |
Query object
Field | Description | Type | Required |
---|---|---|---|
|
Conditions to apply using a logical |
Array |
No |
|
Conditions to apply using a logical |
Array |
No |
Request body example that gets active persistent visual alert notifications for one or more units
The following example gets active persistent visual alert notifications for one or more units.
{
"query": {
"and": [
{
"or": [
{
"match": {
"recipients.id": "U1"
}
},
{
"match": {
"recipients.id": "U2"
}
}
]
},
{
"match": {
"recipients.type": "Unit"
}
},
{
"match": {
"notification.variants.type": "PersistentVisualAlert"
}
}
]
},
"paginationContext": {
"maxResults": 10,
"nextToken": "paginationTokenString"
}
}
Request body example that gets active notifications using one or more reference IDs
The following example gets active notifications using one or more reference IDs.
{
"query": {
"or": [
{
"match": {
"notification.referenceId": "R1"
}
},
{
"match": {
"notification.referenceId": "R2"
}
}
]
},
"paginationContext": {
"maxResults": 10,
"nextToken": "paginationTokenString"
}
}
Response header
HTTP/1.1 200 OK
Host: api.amazonalexa.com
Content-Type: application/json
X-Amzn-RequestId: {request-id}
Response header parameters
Field | Description | Type |
---|---|---|
|
Unique identifier for the request. If a problem occurs, Amazon can use this value to troubleshoot the problem. |
String |
Response body example (success)
The following example shows a complete or partially successful response.
{
"paginationContext": {
"nextToken": "paginationTokenString"
},
"successResults": [
{
"recipients": [
{
"type": "Unit",
"id": "amzn1.alexa.unit.did.{unitId1}"
}
],
"notification": {
"variants": [
{
"type": "PersistentVisualAlert",
"content": {
"variants": [
{
"type": "V0Template",
"values": [
{
"locale": "en-US",
"document": {
"type": "Link",
"src": "doc://alexa/apl/documents/enterprise/notifications/persistentvisualalert/textWrappingTemplate"
},
"datasources": {
"displayText": {
"primaryText": "Example notification primary text.",
"secondaryText": "Example notification text."
},
"background": {
"backgroundImageSource": "https://www.example.com/image.jpg"
}
}
}
]
}
]
},
"dismissalTime": "2021-04-30T10:00:00.00Z"
}
],
"referenceId": "595973fd-5b66-4970-9401-example"
}
}
]
}
Response body example (error)
The following example shows an error response.
{
"type": "BAD_REQUEST",
"message": "Invalid payload format, please check documentation."
}
Response body parameters
Field | Description | Type |
---|---|---|
|
Object containing pagination information. If omitted, all evaluation results were already returned. |
Object |
|
Continuation token that you use in the next call to query persistent visual alerts. If this field is null, all evaluation results were already returned. If this field isn't null, there are more results in the next page. |
String |
|
List of persistent visual alert notifications that matched the query criteria. For the possible properties of a notification, see the request body for the Send notification operation. |
Array of objects |
HTTP response codes
Status Code | Name | Description |
---|---|---|
200 |
OK |
The request succeeded. |
400 |
Bad Request |
The request is malformed or is missing one or more required parameters. |
401 |
Unauthorized |
The access token is missing, expired, or invalid. |
403 |
Forbidden |
The user doesn't have permission to perform the operation. |
429 |
Too Many Requests |
Request is throttled. |
500 |
Internal Server Error |
The request couldn't be handled because of an internal service error. |
503 |
Service Unavailable |
Service is temporarily unavailable. |
Persistent visual alert templates
Persistent visual alerts require the premium multimodal add-on subscription. For details, see Premium Multimodal.
The following sections provide details about each of the available templates you can use for a persistent visual alert. Specify the template in the notification.variants[].content.variants[].values[].document.src
property of the Send notifications request body. Then set the fields for the template in the notification.variants[].content.variants[].values[].datasources
object.
About background images
For each of these templates, you can provide a background image with the background.backgroundImageSource
property. The template scales the image uniformly up or down to completely fill the screen ("best-fill"). This means that the image might get cut off if there is a mismatch between the aspect ratio of the image and the device screen.
For best results with images, consider the following recommendations:
- Avoid using images with text that extends to the edges of the image, as this text might be truncated due to the scaling.
- If possible, test your images on the same device types used in your units.
- If separate units contain different devices, consider targeting the different units with separate persistent visual alerts so that you can optimize the images for the devices. This strategy works when all the devices in a given unit have the same aspect ratio.
- By default, the templates apply a scrim to the background image to make the text over the image easier to read. If this makes the image too dark, you can turn it off by setting the
background.colorOverlay
property for the template tofalse
.
You can provide images in PNG or JPG format. The image files can't exceed 400 KB in size.
Option list
The option list template (doc://alexa/apl/documents/enterprise/notifications/persistentvisualalert/optionListTemplate
) displays text, a background image, and components the user can tap to take actions you define. The template displays the content and buttons with different layouts depending on the properties you set in the request:
- Centered text with one or more buttons – Buttons can use icons or text. You might use this variant for a daily check in with thumbs up and thumbs down buttons or a small number of multiple-choice answers. For examples, see Centered text with one or more buttons example.
- Text displayed side-by-side with a thumbnail image – This variant displays buttons below the main text. You might use this variant to remind users of an upcoming health provider visit or property event. For an example, see Text displayed side-by-side with a thumbnail image example.
- Menu of items with images – This variant displays each button as a thumbnail images with primary and secondary text. Users can tap on an item to trigger an action. You might use this variant to display a menu of upcoming events or food options for a meal. The template looks best when the items display in a single row, so limit the number of items to include. For an example, see Menu of items with image thumbnails example.
The option list template has the following properties within the notification.variants[].content.variants[].values[].datasources
object.
Property name | Description | Type | Required? |
---|---|---|---|
|
URL for the attribution image to display |
String |
No |
|
URL for the background image. When choosing images, see the recommendations in About background images. |
String |
No |
|
When |
Boolean |
No, defaults to |
|
Header text displayed before all the other text fields. |
String |
No |
|
Hint text displayed at the bottom of the screen. |
String |
No |
|
An array of option objects that define the buttons to display. For the properties in this object, see Option list object. |
Array |
No |
|
Primary text to display. This text displays in a larger font than the rest of the text. |
String |
Yes |
|
Secondary text displayed under the primary text in a smaller font. |
String |
No |
|
URL for a thumbnail image to display next to the text. When provided, the template positions the text next to the image. If you set this property to an empty string, the template left-aligns the text and buttons and doesn't display an image. When not provided, the template centers the text fields. |
String |
No |
Option list object
The optionList
property accepts an array of option objects. Each object defines a button or other component that the user can tap to take an action. The template displays the buttons in different styles depending on the properties you set:
- Icon button – Set the
iconName
andactions
properties. - Text button – Set the
primaryText
andactions
properties.. - Menu item with a thumbnail image – Set the
primaryText
,secondaryText
,src
, andactions
properties. Limit the number of items you provide to make sure that they can all fit on a single row. Three or fewer works with most devices.
The following table defines the properties you can set in an option object.
Property name | Description | Type | Required? |
---|---|---|---|
|
An array of action objects that define the actions to take when the user taps the component. A button can trigger multiple actions, such as launching a skill and dismissing the notification. |
Array |
No |
|
The type of action to take when the user taps the button.
|
String |
Yes |
|
A URI to the skill associated with the card in the format Example: |
String |
No |
|
The value to pass to the specified skill. Applies when |
String |
No |
|
The name of the icon to display. You can use an icon from the Alexa Icon Library. For example, set this property to |
String |
No |
|
The text to display on the button.
|
String |
No |
|
Text to display under an image list item. Applies when |
String |
No |
|
URI for the image to use for an item in a menu of items. |
String |
No |
Centered text with one or more buttons example
The following example displays a quick check in notification with the thumbs up and thumbs down buttons.
A similar check in screen can use plain text buttons to offer a wider range of options.
Text displayed side-by-side with a thumbnail image example
The following example displays text side-by-side with an image. This layout is useful for reminders and call-to-action scenarios such as asking users to register for an event.
Menu of items with image thumbnails example
The following example displays a list of three items to provide information about available events.
Text wrapping
The text wrapping template has the following properties within the notification.variants[].content.variants[].values[].datasources
object.
Property name | Description | Type | Required? |
---|---|---|---|
|
URL for the attribution image to display. Provide either |
String |
No |
|
Attribution text displayed under the other text fields. Provide either |
String |
No |
|
URL for the background image. When choosing images, see the recommendations in About background images. |
String |
No |
|
When |
Boolean |
No, defaults to |
|
Header text displayed before all the other text fields. |
String |
No |
|
Hint text displayed at the bottom of the screen. |
String |
No |
|
Primary text to display. This text displays in a larger font than the rest of the text. |
String |
Yes |
|
Secondary text displayed under the primary text in a smaller font. |
String |
No |
|
Tertiary text displayed next to the secondary text. |
String |
No |
Media
The media template has the following properties within the notification.variants[].content.variants[].values[].datasources
object.
Property name | Description | Type | Required? |
---|---|---|---|
|
URL for the attribution image to display. Provide either |
String |
No |
|
Attribution text displayed under the other text fields. Provide either |
String |
No |
|
URL for the background image. When choosing images, see the recommendations in About background images. |
String |
No |
|
When |
Boolean |
No, defaults to |
|
Header text displayed before all the other text fields. |
String |
No |
|
Hint text displayed at the bottom of the screen. |
String |
No |
|
Primary text to display. This text displays in a larger font than the rest of the text. |
String |
Yes |
|
Secondary text displayed under the primary text in a smaller font. |
String |
No |
|
Tertiary text displayed next to the secondary text. |
String |
No |
|
URL for the image thumbnail to display next to the text fields. |
String |
No |
Rating
The rating template has the following properties within the notification.variants[].content.variants[].values[].datasources
object.
Property name | Description | Type | Required? |
---|---|---|---|
|
URL for the background image. When choosing images, see the recommendations in About background images. |
String |
No |
|
When |
Boolean |
No, defaults to |
|
Header text displayed before all the other text fields. |
String |
No |
|
Hint text displayed at the bottom of the screen. |
String |
No |
|
Primary text to display. This text displays in a larger font than the rest of the text. |
String |
Yes |
|
Number of stars for the rating. The rating number can be between one and five, and can include half stars, such as |
Number between one and five |
Yes |
|
Brief text to give context to the star rating. Must be fewer than eight characters. |
String |
Yes |
|
URL for the image thumbnail to display. |
String |
No |
Related topics
Last updated: Jun 26, 2024