Viafoura

Guides
Need Help?

{{user.name}}Log In

The Viafoura Documentation Hub

Welcome to the Viafoura documentation hub. You'll find comprehensive guides and documentation to help you start working with Viafoura as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started API Reference

HomeGuidesRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Implementation

Getting Started
Integration with your content
Conversations
Community Chats
Live Blogs
Additional Engagement Tools
Notifications
Mobile Integration
CSS and Customization
Loading Widgets on other pages
Inline Ad Integration
Content Syndication
Single Page App Setup
Continuous Scroll Setup

FAQ

My widget is not showing up. What did I miss?
How to retrieve comments of a page using APIs
How does Viafoura work with Adblocking plugins?
How to defer the load of Viafoura widget(s)
How to Allow 3rd-Party Cookie Access
What Cookies are used by Viafoura?

Identity Management

Authentication
Janrain Integration
Viafoura Custom Cookie Login
Custom Login Integration
OpenIDConnect Integration

JS API

Viafoura Javascript API
- Viafoura Events

Data

User Engagement Data API
Server-to-Server Callbacks
Data Import Specifications

User Guides

Live Blogging
Community Chat
On-site Moderation
Viafoura Admin Section
- Analytics
- Site Settings

Moderation Console

Introduction
Workspaces
Queues
- Creating a Queue
Moderating Posts
User Ban
Saved Searches
- Create a Saved Search
Posts
Tags
Filters

Implementation

Getting Started
Integration with your content
Conversations
Community Chats
Live Blogs
Additional Engagement Tools
Notifications
Mobile Integration
CSS and Customization
Loading Widgets on other pages
Inline Ad Integration
Content Syndication
Single Page App Setup
Continuous Scroll Setup

FAQ

My widget is not showing up. What did I miss?
How to retrieve comments of a page using APIs
How does Viafoura work with Adblocking plugins?
How to defer the load of Viafoura widget(s)
How to Allow 3rd-Party Cookie Access
What Cookies are used by Viafoura?

Identity Management

Authentication
Janrain Integration
Viafoura Custom Cookie Login
Custom Login Integration
OpenIDConnect Integration

JS API

Viafoura Javascript API
- Viafoura Events

Data

User Engagement Data API
Server-to-Server Callbacks
Data Import Specifications

User Guides

Live Blogging
Community Chat
On-site Moderation
Viafoura Admin Section
- Analytics
- Site Settings

Moderation Console

Introduction
Workspaces
Queues
- Creating a Queue
Moderating Posts
User Ban
Saved Searches
- Create a Saved Search
Posts
Tags
Filters

Viafoura Legacy Engagement API

users
/{site_id}/bootstrap
- post
  Bundles settings, section tree, page and current user together as one request
admin
comments
follow
media
moderation
pages
ratings
- put
  Rate page
sections
/{site_id}/teapot
- get
  get
auth
- get
  /{site_id}/users/logincache/get
- get
  /{site_id}/users/logincache/post

Live Blog API

StoryContainer
StoryMedia
- post
  /{section_uuid}/{content_container_uuid}/media
- get
  Retrieves attributes of a specific media
ContentContainerSettings
- post
  /{section_uuid}/{content_container_uuid}/settings
StoryList
Story
StoryStats
- get
  /{section_uuid}/{content_container_uuid}/posts/visible/count
- get
  /{section_uuid}/{user_uuid}/profile
StoryPins
- put
  /{section_uuid}/{content_container_uuid}/posts/{content_uuid}/pin
- delete
  /{section_uuid}/{content_container_uuid}/posts/{content_uuid}/pin
StoryLikes
StoryPick
- post
  /{section_uuid}/{content_container_uuid}/posts/{content_uuid}/pick
- delete
  /{section_uuid}/{content_container_uuid}/posts/{content_uuid}/pick
StoryFlags
- post
  /{section_uuid}/{content_container_uuid}/replies/{content_uuid}/flags
- delete
  Clears flags (renders them inactive) for a reply
StoryPostReplies
- post
  /{section_uuid}/{content_container_uuid}/replies/{content_uuid}
- delete
  /{section_uuid}/{content_container_uuid}/replies/{content_uuid}
StoryModeration
StoryImport

Chat API

Chat
ChatMedia
- post
  /{section_uuid}/{content_container_uuid}/media
- get
  Retrieves attributes of a specific media
ContentContainerSettings
- post
  /{section_uuid}/{content_container_uuid}/settings/edit
- delete
  /{section_uuid}/{content_container_uuid}/settings/edit
ChatMessage
ChatFlag
- post
  /{section_uuid}/{chat_uuid}/flags/{message_uuid}
- delete
  /{section_uuid}/{chat_uuid}/flags/{message_uuid}
ChatLike
ChatModeration
ChatStats
- get
  /{section_uuid}/{user_uuid}/profile
ChatImport

Authentication & User Management API

Authorization
- post
  Exchanges authentication credentials for access tokens.
Profile
- put
  Creates or updates a badge
- delete
  Removes an existing badge
UserProfile
- put
  Assigns a badge to a user
- delete
  Clears all badges.

Comments API

CommentContainer
CommentMedia
- post
  /{section_uuid}/{content_container_uuid}/media
- get
  Retrieves attributes of a specific media
ContentContainerSettings
- post
  /{section_uuid}/{content_container_uuid}/settings
- delete
  /{section_uuid}/{content_container_uuid}/settings
CommentList
Comment
CommentStats
CommentFlag
- post
  /{section_uuid}/{content_container_uuid}/comments/{content_uuid}/flag
- delete
  /{section_uuid}/{content_container_uuid}/comments/{content_uuid}/flag
CommentLike
CommentPick
- post
  /{section_uuid}/{content_container_uuid}/comments/{content_uuid}/pick
- delete
  /{section_uuid}/{content_container_uuid}/comments/{content_uuid}/pick
CommentPin
- post
  /{section_uuid}/{content_container_uuid}/content/{content_uuid}/pin
- delete
  /{section_uuid}/{content_container_uuid}/content/{content_uuid}/pin
CommentModeration
CommentImport

Viafoura Content API

guest

User Engagement Data API

Health
- get
  /healthy
GeneralEngagement
UserSpecific

User notifications api

NotificationsHealth
- get
  Retreives the service's health
LegacyNotificationsBroadcast
- post
  Send a broadcast notification across the site or topic (legacy / deprecated)
- post
  Send a broadcast notification across the site or topic by using form-data method (legacy / deprecated)
NotificationsSettings
- get
  Get user's notification settings
- post
  Saves user's notifications settings
Notifications
NotificationsBroadcast
- post
  Send a broadcast notification across the site or topic
- post
  Send a broadcast notification across the site or topic by using form-data method
NotificationsTracking
- post
  Notify the server that a push notification has been interacted with.
NotificationsImports
- post
  Import banned content for a section uuid
- post
  Import mutes for a section uuid
SubscriptionsUsers
SubscriptionsPages
SubscriptionsContentContainers
SubscriptionsTopics
SubscriptionsPush
- post
  Enable push notifications for current user
- delete
  Remove push notifications for current user

User Information Compliance API

Health
- get
  /healthy
Gdpr

Webhooks API

WebhookEvents
- post
  webhook for reported events

Powered by

Clients can Create a New Case here

Implementation

Getting Started
Integration with your content
Conversations

FAQ

My widget is not showing up. What did I miss?
How to retrieve comments of a page using APIs
How does Viafoura work with Adblocking plugins?

Identity Management

Authentication
Janrain Integration
Viafoura Custom Cookie Login

JS API

Viafoura Javascript API

Data

User Engagement Data API
Server-to-Server Callbacks
Data Import Specifications

User Guides

Live Blogging
Community Chat
On-site Moderation

Moderation Console

Introduction
Workspaces
Queues