Publishing API

Introduction

Documentation for how to handle publishing and editing directly to a Norkon Pulse page or other pages powered by a Live Center solution.

Abstract

Use this API to publish directly to a Norkon Pulse page and other pages powered by the Live Center. Also including is how to delete published content.

General Information

This document tells you how to publish and delete posts/bulletins of the Live Center through an external CMS/publishing solution.

API Key

The API Key is set by the user through the UI of the Live Center.

While logged in to the Live Center go to the Overview page (“/Overview”). Click the pencil icon for edit - mode.

Then click the pencil-icon for the specific channel you would want to edit.

Various input fields and options will be presented. Under Publish API is the input field for setting and editing the API Key. Also make sure to hook the "Enabled" checkbox before saving.


Publish

Protocol HTTPS (HTTP not allowed)
HTTP Method POST
HTTP Endpoint /BulletinApi/v1/{tenantKey}/Publish

Note: for dedicated hosting solutions, omit the {tenantKey}

POST Arguments

Name Type Required Description
apiKey String Yes The API key (see "General Information")
channelId Integer Yes ID of the channel to publish to
authorId Integer Yes ID of the author to publish for
tags String No Comma separated list of the tags to use. Only tags recognized by the live center will be included.
title String No Title of the post.
html String No HTML of the post. If the HTML does not start with "<", all the text will be placed within a paragraph element.
linkUrl String No Link to scrape for metadata. Supports HTML documents and images. HTML documents will be displayed with a preview, whereas images will be posted directly.
tweetId String No Embeds a tweet to the post, using the tweet ID. Example ID: 818578092209926144
overrideAuthor String No Overrides the author name to whatever is in this string.
stopAutomationKey String No Optional key that can be provided to prevent double posting. If a post exists with a similar automation key, the publishing will be cancelled. If the post is published, the key will be bound to the post.
updateAutomationKey String No Optional key that can be provided to prevent double posting. If a post exists with a similar automation key, the existing post will be updated. The key will be bound to the post.
Importance Integer No The importance of the post. Valid values: 0: Not important

1: Normal

2: Important

3: Very important

breaking Boolean No Whether the post should be displayed as breaking or not (usually with a yellow background to set it apart from other posts, but the actual design is up to the client).


Response Object

Property Type
success Boolean
result Object
errMessage string


Delete

Protocol HTTPS (HTTP not allowed)
HTTP Method POST
HTTP Endpoint /BulletinApi/v1/{tenantKey}/Delete

Note: for dedicated hosting solutions, omit the {tenantKey}


POST Arguments

Name Type Required Description
apiKey String Yes The API key  (see "General Information")
bulletinId Integer Yes ID of the bulletin to delete
channelId Integer Yes ID of the channel to delete from


Response Object

Property Type
success Boolean
result Object
errMessage string
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? How can we help? How can we help?