Reach extensions

GET /api/reach_extensions
get a list of reach_extensions

Success Response Code: 200

Params

Param name Description
page
optional

page number of reach_extensions to be returned (default=1)


Value: Must be a Integer
per_page
optional

number of reach_extensions to be returned per page (default=20, max=500)


Value: Must be a Integer

Response Fields

reach_extensions array of ReachExtension entries. See "GET /api/reach_extensions/:reach_extension_id" for format Array<ReachExtension>

Example Curl Commands

curl -X GET -v --basic -u "adminuser@socialcast.com:adminuser" https://demo.socialcast.com/api/reach_extensions.json

GET /api/reach_extensions/:reach_extension_id
get a single reach_extension for the authenticated reach admin

Success Response Code: 200

Response Fields

id id of the extension Integer
name the name of the extension String
external_system_id the business system id associated with the extension Integer
group_id the group id associated with the extension Integer
url the url associated with the extension String
permanent_url a url that can be used in the browser to view this extension String
extension_type the reach extension type ["discussion", "stream", "recommend", "trends", "dynamic", "recent_thanks"]
stream_type the type of stream associated with this extension String
button_type if the extension is a reach button, the type of button that it is String
install_type the extension's install type ["html", "google_gadget", "sharepoint"]
state indicates whether the extension is currently active String
button_verb the verb associated with the button ["help", "recommend", "review", "share", "thanks"]
profile_heading describes whether the top of the extension will show the header or not Boolean
days_ago If this is a reach trends extension, the number of days that it will consider relevant for computing trends Integer
login_required whether a user is required to login to view this extension's content Boolean
token the reach token needed to be supplied to the reach sample javascript String
reach_border_style the style of the border that will be drawn on the reach iframe ["none", "solid", "dotted", "dashed", "double"]
reach_border_color the color of the border that will be drawn on the reach iframe expressed as an HTML color code String
reach_poweredby_bg the color of the background on "Powered by Reach" expressed as an HTML color code String
reach_entry_border_color the border color for reach entries expressed as an HTML color code String
reach_comment_bg the background color for reach comments expressed as an HTML color code String
reach_default_text the color of standard text for this extension expressed as an HTML color code String
reach_secondary_text the color of secondary text for this extension expressed as an HTML color code String
reach_default_link the color of standard links in this reach extension expressed as an HTML color code String
reach_secondary_link the color of secondary links in this reach extension expresseda as an HTML color code String
reach_button_border the color of the reach button border expressed as an HTML color code String
reach_button_color the color of the button text expressed as an HTML color code String
reach_button_bgcolor the color of the button background expressed as an HTML color code String
reach_button_inner_border the color of the inner border for the reach button expressed as an HTML color code String
reach_button_border_hover the color of the reach button border when the mouse hovers over it expressed as an HTML color code String
reach_button_bgcolor_hover the color of the reach button background when the mouse hovers over it expressed as an HTML color code String
reach_button_textshadow the color of text shadow of the reach button expressed as an HTML color code String
reach_social_button_border the color of the border of a reach social button expressed as an HTML color code String
reach_social_button_text the color of the text of a reach social button expressed as an HTML color code String
reach_social_button_background the color of the background of a reach social button expressed as an HTML color code String
reach_separator_color the color of reach separators expressed as an HTML color code String

Example Curl Commands

curl -X GET -v --basic -u "adminuser@socialcast.com:adminuser" https://demo.socialcast.com/api/reach_extension/12.json

Examples

GET /api/reach_extensions/1.json
200
{
  "reach_extension": {
    "id": 1,
    "name": "Réach d'Extension 1",
    "external_system_id": 8,
    "group_id": null,
    "url": "https://socialcast.socialcast.test/api/reach_extensions/1",
    "permanent_url": "https://socialcast.socialcast.test/tenant_admin/reach_extensions/1",
    "extension_type": "discussion",
    "stream_type": null,
    "button_type": null,
    "install_type": "html",
    "state": "active",
    "button_verb": "recommend",
    "profile_heading": true,
    "days_ago": 7,
    "login_required": true,
    "token": "a63e3569054e9a3832db08c28026b1ed1af6851e",
    "reach_border_style": "solid",
    "reach_border_color": "#d9d9d9",
    "reach_poweredby_bg": "#f2f2f2",
    "reach_entry_border_color": "#e5e5e5",
    "reach_comment_bg": "#efefea",
    "reach_default_text": "#404040",
    "reach_secondary_text": "#8c8c8c",
    "reach_default_link": "#187aab",
    "reach_secondary_link": "#5da2c4",
    "reach_button_border": "#6bb4d8",
    "reach_button_color": "#187aab",
    "reach_button_bgcolor": "#cde4f0",
    "reach_button_inner_border": "#fff",
    "reach_button_border_hover": "#0481c0",
    "reach_button_bgcolor_hover": "#b7d9eb",
    "reach_button_textshadow": "#fff",
    "reach_social_button_border": "#6bb4d8",
    "reach_social_button_text": "#187aab",
    "reach_social_button_background": "#cde4f0",
    "reach_separator_color": "#d9d9d9"
  }
}
GET /api/reach_extensions/1.json
200
{
  "reach_extension": {
    "id": 1,
    "name": "Réach d'Extension 1",
    "external_system_id": 8,
    "group_id": null,
    "url": "https://socialcast.socialcast.test/api/reach_extensions/1",
    "permanent_url": "https://socialcast.socialcast.test/tenant_admin/reach_extensions/1",
    "extension_type": "discussion",
    "stream_type": null,
    "button_type": null,
    "install_type": "html",
    "state": "active",
    "button_verb": "recommend",
    "profile_heading": true,
    "days_ago": 7,
    "login_required": true,
    "token": null,
    "reach_border_style": "solid",
    "reach_border_color": "#d9d9d9",
    "reach_poweredby_bg": "#f2f2f2",
    "reach_entry_border_color": "#e5e5e5",
    "reach_comment_bg": "#efefea",
    "reach_default_text": "#404040",
    "reach_secondary_text": "#8c8c8c",
    "reach_default_link": "#187aab",
    "reach_secondary_link": "#5da2c4",
    "reach_button_border": "#6bb4d8",
    "reach_button_color": "#187aab",
    "reach_button_bgcolor": "#cde4f0",
    "reach_button_inner_border": "#fff",
    "reach_button_border_hover": "#0481c0",
    "reach_button_bgcolor_hover": "#b7d9eb",
    "reach_button_textshadow": "#fff",
    "reach_social_button_border": "#6bb4d8",
    "reach_social_button_text": "#187aab",
    "reach_social_button_background": "#cde4f0",
    "reach_separator_color": "#d9d9d9"
  }
}

POST /api/reach_extensions
create an reach_extension for the authenticated reach admin

Success Response Code: 201

Params

Param name Description
reach_extension
optional

Value: Must be a Hash
reach_extension[name]
required

name of the reach_extension


Value: Must be a String
reach_extension[external_system_id]
required

the id of an external_system


Value: Must be a Integer
reach_extension[group_id]
optional

the id of a group. Deprecated: use container_id / container_type instead


Value: Must be a Integer
reach_extension[container_id]
optional

the id of a Group or TownHall


Value: Must be a Integer
reach_extension[container_type]
optional

allowed values: Group, TownHall


Value: Must be a Integer
reach_extension[install_type]
optional

(default=html)

html

deploy your Reach Extension on any HTML page. Requires JavaScript to be enabled

sharepoint

deploy your Reach Extension as a Sharepoint WebPart (2010 or 2007)

google_gadget

deploy your Reach Extension as a Google Gadget. The only available options for extension_type are dynamic or stream.


Value: Must be one of: <code>html</code>, <code>sharepoint</code>, <code>google_gadget</code>.
reach_extension[extension_type]
optional

(default=discussion)

stream (if this option is selected, stream_type is required)

stream that delivers realtime updates in a themable component that can be embedded anywhere

dynamic

dynamic Extensions are flexible views that can display User Profiles, Discussions, or Group Streams based on metadata in the host page

discussion (if this option is selected, button_verb and button_type are required)

the Reach Discussion Extension allows you to focus discussions around key resources within your business system environment. Now employees can engage in specific conversations related to particular customers, projects, and operational metrics that live in a multitude of systems. Comments get delivered in real-time delivered directly to any page in your organization with the REACH Discussion extension. New messages appear in the stream providing a rich view into the external resource which can include a title, thumbnail, description and any other relevant metadata.

recommend

once a user clicks on a Recommend button on any resource in the enterprise, a rich message is immediately inserted into the Socialcast platform which surfaces the recommendation of that person. Others in the community will now be able to view (and access) this content that was marked as relevant. All Recommendations on an object will be aggregated providing for a relevance driven view into the organization's most valuable content.

trends

the Reach Trends Extension shows a real-time overview of your Socialcast community with trending topics, most active discussions, most active groups and most interesting people

recent_thanks

the Reach Recent Thanks Extension allows you to embed an interactive list of the latest 'Thanks' sent in the Community within any business system. If the viewer has Thanks points available, they can send a 'Thanks' to a co-worker directly from Reach.


Value: Must be one of: <code>discussion</code>, <code>stream</code>, <code>recommend</code>, <code>trends</code>, <code>dynamic</code>, <code>recent_thanks</code>.
reach_extension[stream_type]
optional
profile (profile_header is required)

the Reach Profile Stream detects a User's email in the host page markup and displays their Socialcast Profile Stream. If no user is found, the person viewing the extension will see their own profile.

company

the Reach Company Stream Extension brings realtime updates from your entire company in realtime

custom (either user or tag filters can be used, but not both)

the Reach Custom Stream Extension brings realtime updates for all tags, topics or users that you specify

* to create tags filters, see reach_extension[reach_extension_tag_filters_attributes][:count][tag_name]
* to create users filters, see reach_extension[reach_extension_user_filters_attributes][:counter][user_id]
group

the Reach Group Stream Extension allows you to embed Public and Private Groups (access required) within your business system environment

town_hall

the Reach Town Hall Stream Extension allows you to embed Public and Private Town Halls (access required) within your business system environment

home

the Reach Home Stream Extension makes your Home Stream available from anywhere

default

the Reach Default Stream Extension makes your default Stream (Home, Group, Custom Stream) available from anywhere


Value: Must be one of: <code>profile</code>, <code>company</code>, <code>group</code>, <code>town_hall</code>, <code>custom</code>, <code>home</code>, <code>default</code>.
reach_extension[reach_extension_tag_filters_attributes]
optional

Value: Must be a Hash
reach_extension[reach_extension_tag_filters_attributes][:counter]
optional

Value: Must be a Hash
reach_extension[reach_extension_tag_filters_attributes][:counter][tag_name]
optional

create tag filters for custom stream reach extensions. :counter numbers the tag filters and starts at 0. See curl example below.


Value: Must be a String
reach_extension[reach_extension_user_filters_attributes]
optional

Value: Must be a Hash
reach_extension[reach_extension_user_filters_attributes][:counter]
optional

Value: Must be a Hash
reach_extension[reach_extension_user_filters_attributes][:counter][user_id]
optional

create user filters for custom stream reach extensions. :counter numbers the user filter and starts at 0.


Value: Must be a Integer
reach_extension[button_verb]
optional

(default=recommend)

ask_for_help (button_type should be icon_and_verb or icon)

once a user clicks on a “Ask for Help” button, they will be presented with a share box and link preview for the host web page. When the message is posted to Socialcast, metadata from the page will automatically be attached, providing valuable context to the user's message.

request_assistance (button_type should be icon_and_verb or icon)

once a user clicks on a “Request Assistance” button, they will be presented with a share box and link preview for the host web page. When the message is posted to Socialcast, metadata from the page will automatically be attached, providing valuable context to the user's message.

recommend (button_type should be toggle, count, or names)

once a user clicks on a “Recommend” button on any resource in the enterprise, a rich message is immediately inserted into the Socialcast platform which surfaces the recommendation of that person. Others in the community will now be able to view (and access) this content that was marked as relevant. All Recommendations on an object will be aggregated providing for a relevance driven view into the organization's most valuable content.

like (button_type should be toggle, count, or names)

once a user clicks on a “Like” button on any resource in the enterprise, a rich message is immediately inserted into the Socialcast platform which surfaces the recommendation of that person. Others in the community will now be able to view (and access) this content that was marked as relevant. All Recommendations on an object will be aggregated providing for a relevance driven view into the organization's most valuable content.

request_review (button_type should be icon_and_verb or icon)

once a user clicks on a “Request Review” button, they will be presented with a share box and link preview for the host web page. When the message is posted to Socialcast, metadata from the page will automatically be attached, providing valuable context to the user's message.

share (button_type should be icon_and_verb or icon)

once a user clicks on a “Share” button, they will be presented with a share box and link preview for the host web page. When the message is posted to Socialcast, metadata from the page will automatically be attached, providing valuable context to the user's message.

send_thanks (button_type should be icon_and_verb or icon)

the Reach “Send Thanks” Button allows you to send thanks to co-workers from within any Reach-enabled application. Once a user clicks on the “Send Thanks” Button, they will be able to select the recipient, badge, and include a personal message.


Value: Must be one of: <code>ask_for_help</code>, <code>request_assistance</code>, <code>recommend</code>, <code>like</code>, <code>request_review</code>, <code>share</code>, <code>send_thanks</code>.
reach_extension[button_type]
optional

see rules in button_verb

icon_and_verb

a button embedded with the button_verb text

icon

button with no text embedded

toggle

button that toggles on/off

count

toggle button with a count (e.g. how many likes)

names

toggle button that displays others that like/recommend the same button


Value: Must be one of: <code>icon_and_verb</code>, <code>icon</code>, <code>toggle</code>, <code>count</code>, <code>names</code>.
reach_extension[profile_heading]
optional

(default=true) toogle the display of user profile in a profile stream


Value: Must be one of: <code>true</code>, <code>false</code>.
reach_extension[days_ago]
optional

(default=7) the number of days for reach trends to look back


Value: Must be a Integer
reach_extension[login_required]
optional

(default=true) if true, only Socialcast users can view your reach extension. If false, anyone with the embedded token can view.


Value: Must be one of: <code>true</code>, <code>false</code>.
reach_extension[reach_border_style]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_default_link]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_poweredby_bg]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_secondary_link]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_button_border_hover]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_entry_border_color]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_button_border]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_button_bgcolor_hover]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_comment_bg]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_button_color]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_button_textshadow]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_default_text]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_button_bgcolor]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_secondary_text]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_button_inner_border]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_border_color]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_social_button_border]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_social_button_text]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_social_button_background]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String
reach_extension[reach_separator_color]
optional

(default is set to tenant themes) color setting in hexcode triplets (e.g. #ffeeaa or #fea)


Value: Must be a String

Response Fields

id id of the extension Integer
name the name of the extension String
external_system_id the business system id associated with the extension Integer
group_id the group id associated with the extension Integer
url the url associated with the extension String
permanent_url a url that can be used in the browser to view this extension String
extension_type the reach extension type ["discussion", "stream", "recommend", "trends", "dynamic", "recent_thanks"]
stream_type the type of stream associated with this extension String
button_type if the extension is a reach button, the type of button that it is String
install_type the extension's install type ["html", "google_gadget", "sharepoint"]
state indicates whether the extension is currently active String
button_verb the verb associated with the button ["help", "recommend", "review", "share", "thanks"]
profile_heading describes whether the top of the extension will show the header or not Boolean
days_ago If this is a reach trends extension, the number of days that it will consider relevant for computing trends Integer
login_required whether a user is required to login to view this extension's content Boolean
token the reach token needed to be supplied to the reach sample javascript String
reach_border_style the style of the border that will be drawn on the reach iframe ["none", "solid", "dotted", "dashed", "double"]
reach_border_color the color of the border that will be drawn on the reach iframe expressed as an HTML color code String
reach_poweredby_bg the color of the background on "Powered by Reach" expressed as an HTML color code String
reach_entry_border_color the border color for reach entries expressed as an HTML color code String
reach_comment_bg the background color for reach comments expressed as an HTML color code String
reach_default_text the color of standard text for this extension expressed as an HTML color code String
reach_secondary_text the color of secondary text for this extension expressed as an HTML color code String
reach_default_link the color of standard links in this reach extension expressed as an HTML color code String
reach_secondary_link the color of secondary links in this reach extension expresseda as an HTML color code String
reach_button_border the color of the reach button border expressed as an HTML color code String
reach_button_color the color of the button text expressed as an HTML color code String
reach_button_bgcolor the color of the button background expressed as an HTML color code String
reach_button_inner_border the color of the inner border for the reach button expressed as an HTML color code String
reach_button_border_hover the color of the reach button border when the mouse hovers over it expressed as an HTML color code String
reach_button_bgcolor_hover the color of the reach button background when the mouse hovers over it expressed as an HTML color code String
reach_button_textshadow the color of text shadow of the reach button expressed as an HTML color code String
reach_social_button_border the color of the border of a reach social button expressed as an HTML color code String
reach_social_button_text the color of the text of a reach social button expressed as an HTML color code String
reach_social_button_background the color of the background of a reach social button expressed as an HTML color code String
reach_separator_color the color of reach separators expressed as an HTML color code String

Example Curl Commands

#Create a reach_extension named "Socialcast Developers
curl -X POST -d "reach_extension[name]=Socialcast%20Developers&reach_extension[external_system_id]=1" -v --basic -u "adminuser@socialcast.com:adminuser" https://demo.socialcast.com/api/reach_extensions.json
#Create a custom stream reach_extension with tag filter on sicklog and worklog
curl -X POST -F "reach_extension[name]=TagFilter" -F "reach_extension[external_system_id]=1" -F "reach_extension[extension_type]=stream" -F "reach_extension[stream_type]=custom" -F "reach_extension[reach_extension_tag_filters_attributes][0][tag_name]=worklog" -F "reach_extension[reach_extension_tag_filters_attributes][1][tag_name]=sicklog" -v --basic -u "adminuser@socialcast.com:adminuser" https://demo.socialcast.com/api/reach_extensions.json
#Create a custom stream reach_extension with user filter on user 10 and 11
curl -X POST -F "reach_extension[name]=TagFilter" -F "reach_extension[external_system_id]=1" -F "reach_extension[extension_type]=stream" -F "reach_extension[stream_type]=custom" -F "reach_extension[reach_extension_user_filters_attributes][0][user_id]=10" -F "reach_extension[reach_extension_user_filters_attributes][1][user_id]=11" -v --basic -u "adminuser@socialcast.com:adminuser" https://demo.socialcast.com/api/reach_extensions.json

PUT /api/reach_extensions/:reach_extension_id
update a reach_extension for the authenticated reach admin

Success Response Code: 200

Params

Param name Description
reach_extension
optional

Value: Must be a Hash
reach_extension[state]
optional

this will activate/deactivate reach_extension


Value: Must be one of: <code>deactivated</code>, <code>activated</code>.

Response Fields

id id of the extension Integer
name the name of the extension String
external_system_id the business system id associated with the extension Integer
group_id the group id associated with the extension Integer
url the url associated with the extension String
permanent_url a url that can be used in the browser to view this extension String
extension_type the reach extension type ["discussion", "stream", "recommend", "trends", "dynamic", "recent_thanks"]
stream_type the type of stream associated with this extension String
button_type if the extension is a reach button, the type of button that it is String
install_type the extension's install type ["html", "google_gadget", "sharepoint"]
state indicates whether the extension is currently active String
button_verb the verb associated with the button ["help", "recommend", "review", "share", "thanks"]
profile_heading describes whether the top of the extension will show the header or not Boolean
days_ago If this is a reach trends extension, the number of days that it will consider relevant for computing trends Integer
login_required whether a user is required to login to view this extension's content Boolean
token the reach token needed to be supplied to the reach sample javascript String
reach_border_style the style of the border that will be drawn on the reach iframe ["none", "solid", "dotted", "dashed", "double"]
reach_border_color the color of the border that will be drawn on the reach iframe expressed as an HTML color code String
reach_poweredby_bg the color of the background on "Powered by Reach" expressed as an HTML color code String
reach_entry_border_color the border color for reach entries expressed as an HTML color code String
reach_comment_bg the background color for reach comments expressed as an HTML color code String
reach_default_text the color of standard text for this extension expressed as an HTML color code String
reach_secondary_text the color of secondary text for this extension expressed as an HTML color code String
reach_default_link the color of standard links in this reach extension expressed as an HTML color code String
reach_secondary_link the color of secondary links in this reach extension expresseda as an HTML color code String
reach_button_border the color of the reach button border expressed as an HTML color code String
reach_button_color the color of the button text expressed as an HTML color code String
reach_button_bgcolor the color of the button background expressed as an HTML color code String
reach_button_inner_border the color of the inner border for the reach button expressed as an HTML color code String
reach_button_border_hover the color of the reach button border when the mouse hovers over it expressed as an HTML color code String
reach_button_bgcolor_hover the color of the reach button background when the mouse hovers over it expressed as an HTML color code String
reach_button_textshadow the color of text shadow of the reach button expressed as an HTML color code String
reach_social_button_border the color of the border of a reach social button expressed as an HTML color code String
reach_social_button_text the color of the text of a reach social button expressed as an HTML color code String
reach_social_button_background the color of the background of a reach social button expressed as an HTML color code String
reach_separator_color the color of reach separators expressed as an HTML color code String

Example Curl Commands

#Update reach_extension to name "Socialcast Developers
curl -X PUT -d "reach_extension[name]=Socialcast%20Developers" -v --basic -u "adminuser@socialcast.com:adminuser" http://demo.socialcast.com/api/reach_extensions/12.json