Toggle menu

Setting up Contribute

Create the configuration end point

The configuration for Contribute is held in an end point. There needs to be one configuration end point for each instance of contribute you set up.

Create the namespace

First create the group for your new end point. Configuration follows a naming convention of:

  • "config" - The root group
  • environment (eg "dev", "test", "prod") - This will already exist in iCM
  • application name - A meaningful name for your instance of Contribute
  • "getConfig" - The end point itself

In this example I'm setting up a new instance of Contribute for creating documentation. I'm working on the development site, so I've created a new group called "contributeDocs" in the "dev" namespace:

Configuration End Points

"contributeDocs" is the name I'll need to add to my contribute forms in the next section.

Copy the example end point

There's an example configuration end point at config.example.contributedefault.getConfig.

Copy it and under the "Properties" tab, update the parent group to the group you created above:

End Point Parent

Update the configuration

Now you can enter the information from the previous steps into your configuration.

Contribute End Point Configuration explains all of the options, but to get the minimum working you should enter:

  • Your API key
  • Your root article IDs (where content will be created). Each needs to be added to the rootArticleIds as an object, where "env" is the display text and "articleId" is the ID, for example:
    rootArticleIds: [{
        env: "Library events",
        articleId: 123
    }, {
        env: "Town centre events",
        articleId: 456
    }]
  • Your contribute user group ID
  • The ID of an article template that the submitted articles will use
  • Your media group ID
  • Your metadata group ID 

Then save and publish your end point.

Last modified on 16 March 2026