Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Admins 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 some certain parameters.
Admins 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.
Admins will also be able to broadcast messages directly in the channel.
The SDK supports the sending and receiving of 5 types of messages:
For more information on each of the message types, see Amity Message Types
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, Admins 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.
Admins can filter what messages are to be 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)
*Note: Message will still be marked as sent by user but with no text.
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
Type
Description
Text
A message that contains only text
Image
A message that contains an image
File
A message that contains a file
Audio
A message that contains an audio
Custom
A message that contains any data the user wants to store
Action
Description
Clear flagged
Clears all flags on a message
Delete message
Deletes the message*
Add to blocklist
Admin can select from the message any word or letter they wish to add to the blocklist
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
You'll find an overview of all the real-time event channels we support as a part of our SDK's capabilities in this section. We support Google Pub/Sub and Webhooks to enable you to utilise real time events within your app.
Ideally, you should be able to map the state exposed by the Chat SDK directly to your application UI. You would only need to send the right actions to the SDK, and any update to the state will be emitted to you via LiveObject updates.
All methods in our Chat SDK are designed to return synchronously, and will automatically establish a connection to the server when needed and send the request to the server. If the server is not available, our Chat SDK will queue up any requests and will automatically try to connect to the server with exponential backoff.
In order to provide the best user experience, the Chat SDK will automatically persist its state to the user device's disk. All queries that return a LiveObject will use a cache then network strategy in order to ensure that relevant data is always presented to the user.
LiveObject represents a query that is always updated in real-time, informing you whenever the data in the query changes. It encapsulates all logic around using local cache, querying from the network, and receiving live events from the network into one simple interface.
Our Pub/Sub requires a Google Cloud Service Account, the user can begin receiving events by sending their key.json
credential file to Amity along with the Topic Name
that they wish for the event payloads to communicate to.
Our PubSub currently supports sending payloads for the following events:
When an event is triggered, an HTTP POST payload is sent to the Webhook's configured URL. Webhooks can serve various purposes such as creating push notifications, backup logging or even building external applications based on Webhook events.
Admin users can create new Webhooks in admin panel by using URL
Admin users can delete selected Webhooks in admin panel as well
We support unlimited Webhooks however we have a limitation per network
We recommend having no more than 10 Webhooks/network for stable performance
All Webhooks will be triggered by events, unfortunately we do not allow event customization at this moment
You must detect a secretKey value in the header section (X-Eko-Signature), which will be received when the system sends a Webhook. This is done in order to verify that a request was sent by us
The URL must support POST methods only, unfortunately we do not have any Webhook testing currently available; though this will be coming soon!
Amity does not currently support subscribing to specific events just yet. All the following events will trigger a server response in the form of an HTTP POST payload to the webhook's configured URL.
Though each event has a specific payload format with the relevant event information; they all use the same object structure with the following keys:
The HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain the following headers:
Event name
Description
message.didCreate
Anytime a user in your network creates a message
message.didDelete
Anytime a message is deleted
message.didUpdate
Anytime a message is updated
channel.didCreate
Anytime a channel is created
channel.didJoin
Anytime a user joins a channel
channel.didAddUsers
Anytime a user adds other users to a channel
channel.didClose
Anytime a channel is closed
channel.didLeave
Any time a user leaves a channel
channel.didUpdate
Anytime a channel is updated
channel.didRemoveUsers
Anytime a user is removed from a channel
channel.didUpdateMeta
Anytime a channel's metadata is updated
channel.didBan
Anytime a user is banned from a channel
moderation.didBan
Anytime message that contains a blocklisted word is blocked
community.didCreate
Anytime a community is created
community.didUpdate
Anytime a community is updated
community.didDelete
Anytime a community is deleted
community.didJoin
Anytime a user joins a community
community.didLeave
Anytime a user leaves a community
community.didAddUsers
Anytime a user is added to a community
community.didRemoveUsers
Anytime a user is removed from a community
community.didBan
Anytime a user is banned from a community
community.didUnban
Anytime a user is unbanned from a community
post.didCreate
Anytime a post is created
post.didUpdate
Anytime a post is updated
post.didDelete
Anytime a post is deleted
post.didFlag
Anytime a post is flagged
post.didUnflag
Anytime a post is un-flagged
post.didAddReaction
Anytime a reaction is added to a post
post.didRemoveReaction
Anytime a reaction is removed from a post
comment.didCreate
Anytime a comment is created without a parentID
comment.didUpdate
Anytime a comment is updated
comment.didDelete
Anytime a comment is deleted
comment.didFlag
Anytime a comment is flagged
comment.didUnflag
Anytime a comment is un-flagged
comment.didAddReaction
Anytime a reaction is added to a comment
comment.didRemoveReaction
Anytime a reaction is removed from a comment
comment.didReply
Anytime a comment has a reply
Event name
Description
message.didCreate
any time a user in your network creates a message
channel.didCreate
any time a channel is created
channel.didJoin
any time a user joins a channel
channel.didAddUsers
any time a user adds other users to a channel
Header
Description
requestId
a unique identifier of the post request. You can use it to trace back to our Amity server when there is an issue
webhookId
the subscription iD of the webhook registered to our server.
event
an event name that triggers this POST request
data
the relevant event information that relates to the trigger event. Each event has specific payload format.
Header
Description
x-eko-signature
the HMAC hex digest of the response body.The HMAC hex digest is generated using the sha1 hash function and the secret as the HMAC key.
In order to have moderation privileges, a user has to be assigned a role. Currently we offer three tiers of roles for users and one tier for admins
We determine a user's moderation capabilities based on their current role.
*Note: This role can not be assigned to a user.
Amity Social Cloud Console provides administrators with the ability to observe and control messages in channels.
Moderation tools range from automatic operations such as the blocklisting of words/phrases to controlled operations such as the manual banning and muting of users.
Blocklisting is used to block certain words from being sent in Amity's Chat SDK. When a word is blocklisted, anytime a user attempts to send a message with that word, the message will not be sent. This also applies to words that contain parts of a blocklisted word.
Amity by default prevents any link or url from being sent. However websites can be whitelisted so that links with that website domain can be sent.
As well as the banning and unbanning of users, admins also have the ability to global ban a user. When a user is globally banned, they can no longer access Amity's chat network and will be forcibly removed from all their existing channels. All the globally banned user's messages will also be deleted.
The globally banned user can not access Amity's network again until they have been globally unbanned.
These moderation tools are available to all admins and users with moderator and super-moderator roles
Moderators can mute and unmute users. When a user is muted, they cannot send messages in a channel. However, muted users will still be allowed to observe messages in a channel. The status of being muted is indefinite but is only applied at the channel level.
Moderators can ban and unban users. When a user is banned in a channel, they are forcibly removed from channel and may no longer participate or observe messages in that channel. All their previous messages in the channel will also be automatically deleted.
A user that has been banned from a channel can not rejoin the channel until they have been unbanned.
Admins 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.
Admins 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.
Admins are able to view and manage a list of all blocked expressions from this tab.
Blocked expressions can either be exact or partial matches. This choice of behavior needs to be defined when an admin adds an expression to the list.
Admins can also set the auto mute period (in milliseconds) for when a user uses a blocked expression.
Admins are able to view and manage a list of all allowed expressions 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 allowlist so that users may send it.
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.
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 documentation on Real-Time Events
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 Amity before. Please contact us first so that we can set up the prelimary certificate credentials.
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:
For more information, please have a look at our documentation on:
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:
Roles
Description
None
The user has no moderation privileges
Moderator
The user can assert general moderation privileges on other users
Super-Moderator
The user can assert general moderation privileges and be exempt from moderation from other users
Global-Admin (Admin Only)*
The user can assign the roles of others, assert all moderation privileges and be exempt from moderation
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
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 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.
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
In that tab, an admin can manage entirely the communities of its network. It will be possible to use a filter by name (from the start, case insensitive), and to close (terminate) communities from this panel. The table will also contain the number of posts as a clickable number linking to the post section of the admin panel.
By pushing the "+" button, an admin will be invited to fill a form to create communities. Several options will be presented to customize the community. Once submitted, the community will be automatically visible in the table.
Categories can be accessed from the "Categories" button in the Communities management section. This page allows any admin to add or remove categories which are used for classifying communities.
This page will show the posts attached to a given context. A context can be: an external content, a community or a user. For communities and users, it will be mandatory to input the respective ID.
For example:
To see all the external contents of an admin's network, simply choose "Content" from the filter bar.
To see all the posts of a community's feed, choose "community" and input the chosen community's ID.
To see all the posts of a user's feed, choose "user" and input the chosen user's ID.
There are options to filter posts and reveal only ones that are flagged, as well as deleting a post if admin's deem it to be necessary.
By pushing the "+" button, an admin will be invited to fill a form to create a post. Several options will be presented to customize the post. Admin will have to fill the "target" type and ID to be able to post.
Once submitted, the post will be automatically visible in the table. In case of having attachments, children posts will be automatically created.
The table comes with 2 sets of numbers which are clickable:
the "sub posts" column link will bring an admin to see the posts attached to a parent one.
the "comment" column link will redirect to the comment section with given context of the chosen post.
The comment management section comes empty at first. To see and filter the comments, an admin must fill the context of these comments in the filter bar. It can be an external content, or a post, which for both it needs to fill the corresponding ID.
For example:
To see all the comments of an external content, simply choose "Content" and input the content's ID.
To see all the comments of a post, choose "Post" and input the chosen post's ID.
In this section too are options to filter comments and reveal only flagged ones, as well as deleting a comment if necessary.
In this table an admin can find links to see "sub comments", as in "threaded comments" list. Simply click on the number to reveal the new list of attached comments.
Amity offers a myriad of moderation tools and capabilities designed to offer greater control for the user. Moderation can occur both at the user level and the admin level.
The SDK comes alongside a specialized Amity Social Cloud Console that acts as a dashboard where administrators will be able to observe and control the various data belonging to their network. The Admin Panel also provides a variety of moderation features and customizable settings.
Admin accounts made from the Amity Social Cloud Console also have access to a direct API to our servers. Each Admin account will be granted an Access Token that can be used in correspondence with the endpoints listed here.
For more information on how to retrieve your access token, see our documentation on:
/ Query for channels
Create a new channel
Update a channel's displayName
Add a list of users to a channel
Remove a list of users from a channel
Mute a channel
Unmute a channel
*Note: The endpoints for mute and unmute are exactly the same, channels can be unmuted by setting their
mutePeriod
as 0.
Mute users in a channel
Unmute users in a channel
*Note: The endpoints for mute and unmute are exactly the same, users can be unmuted by setting their
mutePeriod
as 0.
Ban users from a channel
Unban users from a channel
Close a channel
*Note: Currently, closing a channel is irreversible. Once a channel has been closed, all users will be immediately kicked from the channel and all messages deleted in the channel.
Query for messages
Get a message
Create a message in a channel
*Note: When the message type is
text
, our API will expect there to be a text key in the data parameter. This will be the most common use of the message API. When the message type iscustom
, Admin can store any data they wish in the data payload.
Delete a message in a channel
Create an image message in a channel
Get an image from a message
*Note: The
full
size is only available when an image hasfullImage: true
when it was uploaded.
For more information on Image sizes, please have a look at our documentation on:
Create a file message in a channel
Get a file from a message
Get a list of all users
Update a user's information such as displayName, roles and metadata
Global ban a user, that user can no longer access the SDK
Global unban a user, that user can access the SDK again
Clear the flags on a user
Get a list of all roles
Add a role
*Note: The permissions and roles on the SDK are still a work in progress. We do not yet have predefined permissions to assign to new roles. A revamp of our role system will be coming soon.
Get a list of all blacklisted words
Add blacklisted work
Delete a blacklisted word
Update the word and/or settings of a blacklisted work
Get a list of all whitelisted urls
Add whitelisted url
Delete a whitelisted url
Update the url and/or settings of a whitelisted url
Get a list of userIds who reacted to an item
Create a reaction to an item as Admin
Delete a reaction to an item as Admin
Get a list of messages with the most reactions of a certain name
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
filter
string
The Admin's membership status to filter channels by
<optional>
enum: all
member
notMember
userId
string
The userId to filter channels by
<optional>
tags
Array.<string>
The tags to filter channels by
<optional>
excludeTags
Array.<string>
The tags to exclude in channel filter
<optional>
options
- skip
- limit
- token
Object
skip:
How many channels to skip
limit:
How many channels to return
token:
Return the next/previous set based on pagination token
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
channelId
string
The name of the channel (must be unique)
Content
type
string
The channel type
enum: standard
displayName
string
The display name of the channel
<optional>
metadata
Object
The channel metadata
<optional>
tags
Array.<string>
The channel tags
<optional>
userIds
Array.<string>
An array of userIds to populate the channel
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
channelId
string
The name of the channel (must be unique)
Content
displayName
string
The display name of the channel
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Attributes
:channelId
string
The name of the channel
path
Content
userIds
Array.<string>
An array of userIds to add to the channel
Content
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/json
Name
Data Type
Description
Type
Attributes
:channelId
string
The name of the channel
path
Content
userIds
Array.<string>
An array of userIds to remove from the channel
Content
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/json
Name
Data Type
Description
Type
Default
:channelId
string
The name of the channel
path
Content
mutePeriod
Integer
A period of time (in milliseconds) to mute the channel for
Content
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/json
Name
Data Type
Description
Type
Default
:channelId
string
The name of the channel
path
Content
mutePeriod
Integer
A period of time (in milliseconds) to mute the channel
Content
0 *
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Default
:channelId
string
The name of the channel
path
Content
mutePeriod
Integer
A period of time (in milliseconds) to mute the users
Content
Content
userIds
Array.<string>
An array of userIds to mute
Content
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Default
:channelId
string
The name of the channel
path
Content
mutePeriod
Integer
A period of time (in milliseconds) to mute the users
Content
0 *
userIds
Array.<string>
An array of userIds to mute
Content
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Attributes
:channelId
string
The name of the channel
path
Content
userIds
Array.<string>
An array of userIds to ban
Content
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Attributes
:channelId
string
The name of the channel
path
Content
userIds
Array.<string>
An array of userIds to unban
Content
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Attributes
:channelId
string
The name of the channel
path
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/json
Name
Data Type
Description
Attributes
channelId
string
The channelId to filter messages by
Content
parentId
string
The messageId of the parent message to filter messages by
<optional>
filterByParentId
boolean
Filter results to only show messages with no parentId
default: false
tags
Array.<string>
The tags to filter messages by
<optional>
excludeTags
Array.<string>
The tags to exclude in message filter
<optional>
options
- after
- first
- before
- last
- token
Object
after:
Return messages after a position
first:
Return the first n number of messages
before:
Return messages before a position
last:
Return the last n number of messages
token:
Return the next/previous set based on pagination token
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
:messageId
string
The messageId of the message to get
path
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/json
Name
Data Type
Description
Attributes
channelId
string
The name of the channel to create a message in
Content
type
string
The message type
enum*: text
custom
data
Object
The message data (any text has to be stored in text
key)
text
: Text message to send
tags
Array.<string>
The message tags
<optional>
parentId
string
The parent message of this message (if the message is a comment)
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Name
Data Type
Description
Type
Attributes
:messageId
string
The messageId of the message to delete
path
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
multipart/form-data
Name
Data Type
Description
Attributes
Default
channelId
string
The name of the channel to create a message in
Content
Content
file
Blob
The image to be sent
Content
Content
caption
string
The caption for the image
<optional>
Content
tags
Array.<string>
The message tags
<optional>
Content
parentId
string
The parent message of this message (if the message is a comment)
<optional>
Content
fullImage
boolean
If the original image size should be stored
Content
false
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Name
Data Type
Description
Type
Attributes
:messageId
string
The messageId of the message to get image from
path
Content
?size
string
The size of the image to retrieve
query
enum: small
medium
large
full
*
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
multipart/form-data
Name
Data Type
Description
Attributes
channelId
string
The name of the channel to create a message in
Content
file
Blob
The image to be sent
Content
tags
Array.<string>
The message tags
<optional>
parentId
string
The parent message of this message (if the message is a comment)
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Name
Data Type
Description
Type
Attributes
:messageId
string
The messageId of the message to get file from
path
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
Default
search
string
Filter by name
<optional>
Content
filter
string
Filter users by
enum: all
flagged
all
pageToken
string
Return the next/previous set based on pagination token
<optional>
Content
limit
Integer
The number of results
<optional>
10
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencode
Name
Data Type
Description
Attributes
userId
string
UserId to update
Content
displayName
string
The updated displayName
<optional>
roles
Array.<string>
The updated roles
<optional>
metadata
Object
The updated metadata
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
userId
string
The userId to global ban
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
userId
string
The userId to global unban
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Attributes
:userId
string
The userId to clear flags
path
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
filter
string
Filter by role
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
publicIds
Array.<string>
The name of the new role/s
Content
permissions
Array.<string>
The list of permissions
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
regexs
Array.<string>
Filter by word
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
regexs
Array.<string>
Word to be added
Content
isMatchExactWord
boolean
Does word have to be an exact match
default:
false
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
ruleIds
Array.<string>
Words to delete
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Attributes
:ruleId
string
Word to be updated
path
Content
ruleId
string
Word to be updated to
Content
Content
isMatchExactWord
boolean
Does word have to be an exact match
Content
default:
false
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
regexs
Array.<string>
Filter by url
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
regexs
Array.<string>
Url to be added
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
ruleIds
Array.<string>
Urls to delete
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Type
Attributes
:ruleId
string
The url to be updated
path
Content
ruleId
string
Url to be updated to
Content
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
referenceId
string
The referenceId to query reactors for
Content
referenceType
string
The contentType of the referenceId
enum: message
options
- reactionName
- skip
- limit
- token
Object
reactionName:
Filter by a specific reaction name
skip:
Skip the first number of results
limit:
Limit the number of results
token:
Return the next/previous set based on pagination token
<optional>
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
referenceId
string
The referenceId of the item
Content
referenceType
string
The contentType of the referenceId
enum: message
reactionName
string
The name of the reaction
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
referenceId
string
The referenceId of the item
Content
referenceType
string
The contentType of the referenceId
enum: message
reactionName
string
The name of the reaction
Content
Name
Data Type
Value
Authorization
string
Bearer {{Access Token}}
Content-Type
string
application/x-www-form-urlencoded
Name
Data Type
Description
Attributes
limit
Integer
The number of results
Default: 0
reactionName
string
The name of the reaction
Content