Community articleAdding a community widget
Added by IBM contributorIBM on December 21, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars1 comment

Adding a widget to a communty
Tags: commapi

Adding a widget to a communty

To add a new widget to a Community, do a POST to a Widget Feed URL. This creates the widget specified in the widget entry of the request's body. See Community widgets feed for details on the widget entry values.

Table 1. Request/Response Parameters

Request URL
Request Body
Response Body
Possible Errors
<link> entry of a Community's service document with rel=""
Widget Entry - see Community Widgets Feed for entry details
Widget Entry of added widget
  • multiple instances not supported (403)
  • previous widget id doesn't exist (403)
  • prereq service not enabled (403)
  • widget definition not found (403)
  • Community id not found: (500)

Note adding the Media Gallery widget via this API is not supported.

Related Pages

Parent with ATOM entry documentation: Working with community widgets

Method URI Description
POST /communities/service/atom/community/widgets <link> entry of a Community's service document with rel=""
Content Type: application/atom+xml
Sample Request:
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns:snx="" xmlns="">>

<title type="text">Library</title>
<category term="widget" scheme="">



Name Type Optional Description
string No The UUID of the community you wish to add the widget to.
string Yes ID of specific widget required. If left blank, all widgets will be added. See "Community widgets feed" document for details on widget entry values.
Content Type: application/atom+xml
Code Description
multiple instances not supported
previous widget id doesn't exist
prereq service not enabled
widget definition not found
Community id not found
Michael Gollmick commented on May 10, 2016

Re: Adding a community widget

What code is returned if the Request succeeds?