Overview

The SDK comes alongside a specialized Admin Panel that acts as a dashboard where administrators will be able to observe and control messages in their channels. The Admin Panel also provides a variety of moderation features and customizable settings.

Channels Management

Admin are able to view all open and closed channels from this tab as well as create a new channel. They will also be able to search for and filter channels by certain parameters.

List of Channel Actions

Action

Description

Mute

Channels members will no longer be able to send new messages in the channel

Unmute

Channels members are able to send new messages in the channel

Stop Channel

Closes a channel. All channel members will be immediately kicked from the channel

Live Messages

Admin can join a channel and view messages being sent in real-time. They also will be able to filter messages by certain parameters, check current members in the channel and modify channel details such as tags and metadata.

Admin will also be able to broadcast messages directly in the channel.

List of Message Types

The SDK supports the sending and receiving of 4 types of messages:

Type

Description

Text

A message that contains only text

Image

A message that contains an image

File

A message that contains a file

Custom

A message that contains any data the user wants to store

For more information on each of the message types, see Upstra Message Types

Pausing Data Stream

Because the messages are being sent in real-time, sometimes an Admin will have difficulty moderating when the messages are appearing quickly. In this scenario, Admin can pause the incoming data stream so that they can take action on a message. This pause does not prevent users from sending messages in a channel but simply stops the Admin Panel from receiving new messages. Once the the live message has been unpaused, Admin will see all the messages again.

Message Filters

Admin can filter what messages are shown on the live message stream. Currently the SDK supports two types of filters:

Filter by Flagged

Show only messages that have been flagged by admin or users

Filter by Threaded

Show only messages that are parent message (See comments below)

Comments

When in Threaded Filter, Admin will be able to see if messages contains comments. When a message has a comment, a + icon will appear next to the message which, when clicked, will show all the comments inside that message.

List of Message Actions

Action

Description

Clear flagged

Clears all flags on a message

Delete message

Deletes the message*

Add to blacklist

Admin can select from the message any word or letter they wish to add to the blacklist

Mute user

User will be unable to send messages in channel

Ban user

User will be immediately kicked from channel and have all messages deleted from channel

*Note: Message will still be marked as sent by user but with no text.

Users Management

Admin are able to view a list of all users from this tab. They will also be able to search for and filter users by certain parameters.

List of User Actions

Action

Description

Change role

Change the role of the user

Global ban user

Kick the user from all channels. Then ban the user from accessing the SDK

Global unban user

Unban the user from accessing the SDK

Blacklist Management

Admin are able to view a list of all blacklisted words from this tab. They will also be able to add a blacklist word, export all current blacklisted words as CSV, import a list of words to blacklist (currently only supports CSV that looks like this: wordToBlacklist, true, true)

Blacklisted words can either be matched by exact word or by partial word. When a new word is added, Admin will have the option to set the behaviour of the match.

Admin can also set the timeout period (in milliseconds) for when a user uses a blacklisted word as well as any role that is exempted from using the blacklist.

Whitelist Management

Admin are able to view a list of all whitelisted URLs from this tab. The default configuration for the SDK is that we do not allow users to send any links or URLS. However, Admin can add an URL to the whitelist so that users may send it.

Settings

Admin are able to modify various settings for the SDK from this panel. Admin will also be able to see their SDK API and Webhook keys from this panel.

Webhook Settings

If the Admin wishes to set up their own webhooks, they can do so by adding a URL to the Webhook section. This will generate a secretKey for that URL webhook. Admin will also be able to delete and previous webhook URLs.

For more information, please have a look at our documention on:

Push Notifications

If the Admin wishes to set up push notifications for their SDK; they may do so by uploading a PNS certificate*. Once a push notification is active, Admin can set what events are push notifiable.

*Note: If client has not enabled Push Notifications with Upstra before. Please contact us first so that we can set up the prelimary certificate credentials.

Push Notification Certificates

Admin can see what certificates are currently active for their Push Notifications. More than one certificate can be uploaded for one platform (i.e. You can have a staging and a production certificate for iOS), however only one certificate may be active at a time per platform and/or provider.

Admin can upload new certificates:

List of Certificate Requirements

Action

Description

Certificate Name

Set the name of the certificate (for Admin tracking purpose)

Platform

Set which platform the certificate is for

Provider (Android Only)

Choose which provider the certificate is for

API Key (Android Only)

Add the API Key for the provider

Upload p12 (iOS Only)

Upload the p12 certificate file

Credential Password (iOS Only)

Add the password for the p12 file

Push Notification Custom Message

For more information, please have a look at our documention on:

Admin User Management

Admin are able to see all current Admin accounts on the SDK as well as create new Admin accounts. The username that is selected will be used as the login name. The display name is the name that users will see when the Admin broadcasts a message.

List of Admin Actions

Action

Description

Edit Admin

Change the Admin's Display Name, First Name and Last Name

Edit password

Change the Admin's password

Settings

Get an Admin's settings

Admin API Access Token

If the Admin wishes to use the Admin API to make requests, they will need an access token. Their access token can be found by going to the Admin's Settings and generating an access token.

Note: For now the Admin access token does not have an expiry date. Pressing on generate token will always return the same access token.

For more information on Admin API, please have a look at our documentation on: