Chatter

Chatter is an enterprise social network for your company that allows employees to connect and collaborate in real time.

Status: Preview

Tier: Premium

Version: 1.0.0

Actions:

Name	Summary
CreatePostInGroup (CreatePostInGroupParameterBody body, string CreatePostInGroupText)	Post to a group
ListGroupMembers (string group_id)	List users in a group
AddUserToGroup (string group_id, AddUserToGroupParameterBody body)	Add user to a group
GetUser (string user_id)	Get user by ID
GetPost (string post_id)	Get post by ID
ListGroups ()	List groups

Triggers:

Name	Summary
TrigNewPostInGroup (string group_id)	When a post is added to a group

Objects:

Name	Summary
ActorUserResponse	Author's
AddUserToGroupParameterBody
CreatePostInGroupParameterBody
CreatePostInGroupResponse
GetPostResponse
GroupMemberResponse
ListGroupMembersResponse
ListGroupsResponse
ListPostsByGroupResponse
OwnerUserResponse	Owner's
UserUserResponse	User

Actions:

CreatePostInGroup

Summary: Post to a group

Description: Create a new post in an existing group.

Syntax:

Chatter.CreatePostInGroup (CreatePostInGroupParameterBody body, string CreatePostInGroupText)

Parameters:

Name

Type

Summary

Required

Related Action

body

CreatePostInGroupParameterBody

True

CreatePostInGroupText

string

(Post Body)

Text content of the post.

True

Returns:

Type:CreatePostInGroupResponse

ListGroupMembers

Summary: List users in a group

Description: List group membership.

Syntax:

Chatter.ListGroupMembers (string group_id)

Parameters:

Name

Type

Summary

Required

Related Action

group_id

string

(Group ID)

Group

True

ListGroups

Returns:

Type:ListGroupMembersResponse

AddUserToGroup

Summary: Add user to a group

Description: Adds a member to an existing group.

Syntax:

Chatter.AddUserToGroup (string group_id, AddUserToGroupParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

group_id

string

(Group ID)

Group

True

ListGroups

body

AddUserToGroupParameterBody

True

Returns:

Type:GroupMemberResponse

GetUser

Summary: Get user by ID

Description: Get a user's details by id.

Syntax:

Chatter.GetUser (string user_id)

Parameters:

Name

Type

Summary

Required

Related Action

user_id

string

(User ID)

Unique id of the user.

True

Returns:

Type:UserUserResponse

Summary: User

GetPost

Summary: Get post by ID

Description: Get details of a post by post id.

Syntax:

Chatter.GetPost (string post_id)

Parameters:

Name

Type

Summary

Required

Related Action

post_id

string

(Post ID)

Unique id of the post.

True

Returns:

Type:GetPostResponse

ListGroups

Summary: List groups

Description: List groups

Syntax:

Chatter.ListGroups ()

Returns:

Type:ListGroupsResponse

Triggers:

Trigger TrigNewPostInGroup

Summary: When a post is added to a group

Description: Triggers when a new post is added to an existing group.

Syntax:

Chatter.TrigNewPostInGroup (string group_id)

Parameters:

Name

Type

Summary

Required

Related Action

group_id

string

(Group ID)

Group

True

ListGroups

Returns:

Type:ListPostsByGroupResponse

ActorUserResponse

Summary: Author's

Description:

Properties:

Name	Type	Summary
companyName	string Company Name	Name of the company.
displayName	string Display Name	User name of the author.
id	string User ID	Unique identifier of the author.
name	string Name	First and last name of the author.
photo	Photo Photo
title	string Title	Title of the author.

Photo

Summary: Photo

Description:

Properties:

Name	Type	Summary
largePhotoUrl	string (large)	Profile image of the author.
mediumPhotoUrl	string (medium)	Profile image of the author.
smallPhotoUrl	string (small)	Profile image of the author.

AddUserToGroupParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

userId

string

Salesforce User ID

Unique id of the user.

CreatePostInGroupParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

subjectId

string

Group ID

Group

CreatePostInGroupResponse

Summary:

Description:

Properties:

Name	Type	Summary
actor	ActorUserResponse Author's
body	Body Post Body
createdDate	string(date-time) Date Posted	Date-Time in ISO-8601 format.
header	Header Header
id	string ID	Unique id of the feed item.
modifiedDate	string(date-time) Modified date	Date-Time in ISO-8601 format.
parent	Parent Parent
type	string Type	Type of the post.
visibility	string Visbility	Who can see the post.

Body

Summary: Post Body

Description:

Properties:

Name

Type

Summary

isRichText

boolean

Is Rich Text

True if the message is in rich text format.

text

string

Text

Display-ready text of the message.

Header

Summary: Header

Description:

Properties:

Name

Type

Summary

isRichText

string

Is Rich Text

True if the header is in rich text format.

text

string

Text

Title of the post.

Parent

Summary: Parent

Description:

Properties:

Name	Type	Summary
description	string Description	Description of the parent object.
id	string ID	Unique id of the parent object.
name	string Name	Name of the parent object.
owner	OwnerUserResponse Owner's
type	string Type	Type of the parent object.
visibility	string Visbility	Who can see the parent object.

GetPostResponse

Summary:

Description:

Properties:

Name	Type	Summary
actor	ActorUserResponse Author's
body	Body Post Body
createdDate	string(date-time) Date Posted	Date-Time in ISO-8601 format.
header	Header Header
id	string ID	Unique id of the feed item.
modifiedDate	string(date-time) Modified Date	Date-Time in ISO-8601 format.
parent	Parent Parent
type	string Type	Type of the post.
visibility	string Visbility	Who can see the post.

Body

Summary: Post Body

Description:

Properties:

Name

Type

Summary

isRichText

boolean

Is Rich Text

True if the message is in rich text format.

text

string

Text

Display-ready text of the post.

Header

Summary: Header

Description:

Properties:

Name

Type

Summary

isRichText

string

Is Rich Text

True if the header is in rich text format.

text

string

Text

Title of the post.

Parent

Summary: Parent

Description:

Properties:

Name	Type	Summary
description	string Description	Description of the parent object.
id	string ID	Unique id of the parent object.
name	string Name	Name of the parent object.
owner	OwnerUserResponse Owner's
type	string Type	Type of the parent object.
visibility	string Visbility	Who can see the parent object.

GroupMemberResponse

Summary:

Description:

Properties:

Name	Type	Summary
id	string Member ID	Unique identifier of the member.
role	string Role	Member's role in the group.
url	string URL	Link to member's user profile.
user	UserUserResponse User

ListGroupMembersResponse

Summary:

Description:

Properties:

Name

Type

Summary

members

array of (GroupMemberResponse)

totalMemberCount

integer(int32)

Total member count

Number of members in the group.

ListGroupsResponse

Summary:

Description:

Properties:

Name

Type

Summary

groups

array of (GroupsItem)

GroupsItem

Summary:

Description:

Properties:

Name

Type

Summary

string

name

string

ListPostsByGroupResponse

Summary:

Description:

Properties:

Name

Type

Summary

elements

array of (ElementsItem)

ElementsItem

Summary:

Description:

Properties:

Name	Type	Summary
actor	ActorUserResponse Author's
body	Body Post Body
createdDate	string(date-time) Date Posted	Date-Time in ISO-8601 format.
header	Header Header
id	string ID	Unique id of the feed item.
modifiedDate	string(date-time) Modified Date	Date-Time in ISO-8601 format.
parent	Parent Parent
type	string Type	Type of the post.
visibility	string Visbility	Who can see the post.

Body

Summary: Post Body

Description:

Properties:

Name

Type

Summary

isRichText

boolean

Is Rich Text

True if the message is in rich text format.

text

string

Text

Display-ready text of the message.

Header

Summary: Header

Description:

Properties:

Name

Type

Summary

isRichText

string

Is Rich Text

True if the header is in rich text format.

text

string

Text

Title of the post.

Parent

Summary: Parent

Description:

Properties:

Name	Type	Summary
description	string Description	Description of the parent object.
id	string ID	Unique id of the parent object.
name	string Name	Name of the parent object.
owner	OwnerUserResponse Owner's
type	string Type	Type of the parent object.
visibility	string Visbility	Who can see the parent object.

OwnerUserResponse

Summary: Owner's

Description:

Properties:

Name	Type	Summary
companyName	string Company Name	Name of the company.
displayName	string Display Name	User name of the owner.
id	string User ID	Unique identifier of the owner.
name	string Name	First and last name of the owner.
photo	Photo Photo
title	string Title	Title of the owner.

Photo

Summary: Photo

Description:

Properties:

Name	Type	Summary
largePhotoUrl	string (large)	Profile image of the owner.
mediumPhotoUrl	string (medium)	Profile image of the owner.
smallPhotoUrl	string (small)	Profile image of the owner.

UserUserResponse

Summary: User

Description:

Properties:

Name	Type	Summary
companyName	string Company Name	Name of the company.
displayName	string Display Name	User's display name.
id	string ID	Unique identifier of the user.
name	string Name	First and last name of the user.
photo	Photo Photo
title	string Title	User's title.

Photo

Summary: Photo

Description:

Properties:

Name	Type	Summary
largePhotoUrl	string (large)	Profile image of the user.
mediumPhotoUrl	string (medium)	Profile image of the user.
smallPhotoUrl	string (small)	Profile image of the user.