VIviafoura
NotificationsBroadcast

Send a broadcast notification across the site or topic

Post a broadcast notification to all users (even the non-authenticated ones). This endpoint can also send a broadcast notification to users who subscribed to a topic.

post/v5/notifications/{site_uuid}/broadcast

Request

  • Base URL
    https://notifications.viafoura.co
  • URL
    https://notifications.viafoura.co/v5/notifications/{site_uuid}/broadcast
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

site_uuidstring uuid required

Request body

titlestring required

The title of the broadcast.

descriptionstring required

The description of the broadcast.

image_urlstring required

The url of the image that will be displayed.

urlstring required

The url that the user will be redirected to on-click.

push_time_to_liveinteger

The time, in seconds, a push notification should be retained once it has been sent to to Push Service, but not received by the end-user's browser. This can happen when a user's computer is powered off, their browser is not running, or their device does not have access to the internet. Default is 4 weeks. If set to 0, the notification will only be sent to users who can receive it immediately.

topic_idstring

A string to represent the topic id. For site broadcasting, topic_id should not be included. For topic broadcasting, the topic_id must be unique for each topic.

broadcast_type'site' | 'topic' required

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.