Broadcast Notifications Instructions

This feature allows you to create a message that can be delivered to all users through Browser Notifications and Viafoura's Notification Tray, even if the user isn't logged in or doesn't have an account on your site.

Viafoura supports sending broadcast notifications to all users through the notification tray and via browser based push notifications for users who have opted in. We do not provide a GUI to send broadcast messages at this time, so implementation requires use of our notification APIs. In order to send broadcast notifications you must generate a JSON Web Token (JWT) and use it to send notifications via API by following the steps below.

Step 1: Obtain Credentials

Encrypted credentials are needed to use the APIs. A client ID and secret pair with the appropriate permission levels will be provided to you by your client success representative. (please contact our support team).

With these credentials, you can follow the next steps to launch broadcast notifications.

Step 2: Create a JWT

Use the Client ID and Secret to create a JWT to use as authorization for the API calls (https://documentation.viafoura.com/reference#authorization).

📘

Note:

  1. Each JWT is only valid for 5 minutes.
  2. You will need to provide the section_uuid that identifies the site you want to send the notification to as the "scope". If you don't know the section_uuid of the site, please [reach out to our support team].(https://documentation.viafoura.com/page/create-a-new-case).
  3. For this endpoint, the authentication header when passing your credentials should be BASIC.

Step 3: Send broadcast

Use the newly created JWT as authorization in the broadcast endpoints. You can use https://documentation.viafoura.com/reference#sendbroadcasttosection or https://documentation.viafoura.com/reference#sendbroadcasttosectionform.

📘

Note:

  1. You will need to provide the section_UUID that identifies the site you want to send the notification to. If you don't know the section_UUID of the site, please [reach out to our support team].
  2. For this endpoint, the authentication header when passing your JWT token should be BEARER.

Did this page help you?