Disqus

Disqus is a service for web comments and discussions. Disqus makes commenting easier and more interactive, helping publishers power online discussions.

Status: Preview

Tier: Standard

Version: 1.0.0

Actions:

Name	Summary
CreatePost (string thread, string message)	Create a comment
ReplyToPost (string parent, string message)	Reply to a comment
RemovePost (string post)	Remove a comment
GetFollowedForums ([internal][Optional]string order, [internal][Optional]integer limit)	Get followed channels
SubscribeToThread (string thread)	Follow a discussion
OpenThread (string thread)	Open a discussion
CloseThread (string thread)	Close a discussion
RecommendThread (string thread, [internal]string vote)	Recommend a discussion
GetThread (string thread)	Get discussion by Id
GetForumThreads (string forum, [internal][Optional]string order, [internal][Optional]integer limit)	Get discussions in a channel

Triggers:

Name	Summary
OnPostCreated (string forum, [Optional]string thread, [internal][Optional]string order, [internal][Optional]integer limit)	When a comment is created
OnThreadCreated (string forum, [internal][Optional]string order, [internal][Optional]integer limit)	When a discussion is created

Objects:

Name	Summary
Author
CreatePostResponse
EmptyResponse
Forum
GetThreadResponse
OperationResultResponse
Post
RecommendThreadResponse
Thread

Actions:

CreatePost

Summary: Create a comment

Description: Create a comment on a specified thread.

Syntax:

Disqus.CreatePost (string thread, string message)

Parameters:

Name

Type

Summary

Required

Related Action

thread

string

(Discussion Id)

The unique id of the discussion

True

message

string

(Message)

The content of the comment.

True

Returns:

Type:CreatePostResponse

ReplyToPost

Summary: Reply to a comment

Description: Reply to a specified comment.

Syntax:

Disqus.ReplyToPost (string parent, string message)

Parameters:

Name

Type

Summary

Required

Related Action

parent

string

(Parent Comment Id)

The id of the comment to reply to.

True

message

string

(Message)

The content of the comment.

True

Returns:

Type:CreatePostResponse

RemovePost

Summary: Remove a comment

Description: Remove a comment.

Syntax:

Disqus.RemovePost (string post)

Parameters:

Name

Type

Summary

Required

Related Action

post

string

(Comment Id)

The id of the comment to remove.

True

Returns:

Type:OperationResultResponse

GetFollowedForums

Summary: Get followed channels

Description: Get a list of the channels the current user follows.

Syntax:

Disqus.GetFollowedForums ([internal][Optional]string order, [internal][Optional]integer limit)

Parameters:

Name

Type

Summary

Required

Related Action

order

string

False

limit

integer(int32)

False

Returns:

Type:array of (Forum)

SubscribeToThread

Summary: Follow a discussion

Description: Follow a discussion.

Syntax:

Disqus.SubscribeToThread (string thread)

Parameters:

Name

Type

Summary

Required

Related Action

thread

string

(Discussion Id)

The unique id of the discussion to follow.

True

Returns:

Type:EmptyResponse

OpenThread

Summary: Open a discussion

Description: Opens a discussion (for moderators of this forum only).

Syntax:

Disqus.OpenThread (string thread)

Parameters:

Name

Type

Summary

Required

Related Action

thread

string

(Discussion Id)

The unique id of the discussion to open.

True

Returns:

Type:OperationResultResponse

CloseThread

Summary: Close a discussion

Description: Closes a discussion (for moderators of this forum only).

Syntax:

Disqus.CloseThread (string thread)

Parameters:

Name

Type

Summary

Required

Related Action

thread

string

(Discussion Id)

The unique id of the discussion to close.

True

Returns:

Type:OperationResultResponse

RecommendThread

Summary: Recommend a discussion

Description: Recommend a discussion.

Syntax:

Disqus.RecommendThread (string thread, [internal]string vote)

Parameters:

Name

Type

Summary

Required

Related Action

thread

string

(Discussion Id)

The unique id of the discussion to recommend.

True

vote

string

True

Returns:

Type:RecommendThreadResponse

GetThread

Summary: Get discussion by Id

Description: Returns the details of a discussion by Id.

Syntax:

Disqus.GetThread (string thread)

Parameters:

Name

Type

Summary

Required

Related Action

thread

string

(Discussion Id)

The unique id of the discussion.

True

Returns:

Type:GetThreadResponse

GetForumThreads

Summary: Get discussions in a channel

Description: Returns a list of discussions in the specified channel.

Syntax:

Disqus.GetForumThreads (string forum, [internal][Optional]string order, [internal][Optional]integer limit)

Parameters:

Name	Type	Summary	Required	Related Action
forum	string (Channel)	The unique name of the channel	True	GetFollowedForums
order	string		False
limit	integer(int32)		False

Returns:

Type:array of (Thread)

Triggers:

Trigger OnPostCreated

Summary: When a comment is created

Description: Triggers a flow when a comment is created on a specified discussion.

Syntax:

Disqus.OnPostCreated (string forum, [Optional]string thread, [internal][Optional]string order, [internal][Optional]integer limit)

Parameters:

Name	Type	Summary	Required	Related Action
forum	string (Channel)	The unique name of the channel	True	GetFollowedForums
thread	string (Discussion)	The unique id of the discussion.	False	GetForumThreads
order	string		False
limit	integer(int32)		False

Returns:

Type:array of (Post)

Trigger OnThreadCreated

Summary: When a discussion is created

Description: Triggers a flow when a discussion is created on a specified forum.

Syntax:

Disqus.OnThreadCreated (string forum, [internal][Optional]string order, [internal][Optional]integer limit)

Parameters:

Name	Type	Summary	Required	Related Action
forum	string (Channel)	The unique name of the channel	True	GetFollowedForums
order	string		False
limit	integer(int32)		False

Returns:

Type:array of (Thread)

Author

Summary:

Description:

Properties:

Name	Type	Summary
id	string Author Id	The id of the author.
joinedAt	string(date-time) Author Join Date	The date/time the author joined Disqus.
isVerified	boolean Is Verified Author	Set to true if the author is verified.
username	string Author Username	The username of the author.
about	string About the Author	Details about the author.
name	string Author Name	The name of the author.
profileUrl	string Author Profile URL	The URL of the author profile.
isAnonymous	boolean Is Anonymous Author	Set to true if the author is anonymous.

CreatePostResponse

Summary:

Description:

Properties:

Name

Type

Summary

response

Post

EmptyResponse

Summary:

Description:

Properties:

Name

Type

Summary

response

Response

Summary:

Description:

Properties:

Name

Type

Summary

Forum

Summary:

Description:

Properties:

Name	Type	Summary
description	string HTML Description	The description of the channel in HTML.
url	string Channel URL	The URL of the channel.
raw_description	string Description	The description of the channel in raw format (not HTML).
language	string Language	Language Code
daysAlive	integer(int32) Days Alive	The number of days the channel has been alive.
id	string Channel Id	The id of the channel.
createdAt	string(date-time) Created At	The date/time the channel was created at.
name	string Channel Name	The name of the channel.

GetThreadResponse

Summary:

Description:

Properties:

Name

Type

Summary

response

Thread

OperationResultResponse

Summary:

Description:

Properties:

Name

Type

Summary

response

array of (ResponseItem)

ResponseItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Post

Summary:

Description:

Properties:

Name	Type	Summary
dislikes	integer(int32) Dislikes	Number of dislikes.
thread	string Discussion Id	The id of the discussion.
likes	integer(int32) Likes	Number of likes.
message	string HTML Message	The message text in HTML.
id	string Comment Id	The id of the comment.
author	Author
isSpam	boolean Is Spam
createdAt	string(date-time) Created At	The date/time the comment was created at.
parent	integer(int32) Parent Comment Id	The id of the parent discussion.
isApproved	boolean Is Approved	Set to true if the moderator has approved the comment.
isFlagged	boolean Is Flagged	Set to true if the comment has been flagged.
raw_message	string Message	The message text in raw format (not HTML).
isHighlighted	boolean Is Featured	Set to true if the comment is featured.
forum	string Channel Id	The id of the channel.
isEdited	boolean Is Edited	Set to true if the comment is edited.

RecommendThreadResponse

Summary:

Description:

Properties:

Name

Type

Summary

response

Response

Summary:

Description:

Properties:

Name

Type

Summary

thread

Thread

vote

integer(int32)

Vote

Result after voting

Thread

Summary:

Description:

Properties:

Name	Type	Summary
feed	string RSS Feed	The URL of the RSS feed.
dislikes	integer(int32) Dislikes	The number of dislikes on the discussion.
likes	integer(int32) Likes	The number of likes on the discussion.
message	string HTML Message	The message text in HTML.
id	string Discussion Id	The id of the discussion.
author	string Author Id	The id of the author.
createdAt	string(date-time) Created At	The date/time the discussion was created at.
raw_message	string Message	The message text in raw format (not HTML).
link	string Link	The link to the discussion.
forum	string Channel Id	The id of the channel.
clean_title	string
posts	integer(int32) Number of comments	The number of comments on this discussion.
title	string Title	The title of the discussion.