Notification Gateway

Concept

nexxOMNIA enables all connected Domains to use a Notification Gateway in order to sync an external system with any change, that happens to any content element within nexxOMNIA. In order to enable this setting, a connected User with the “settings” right need to configure the “Notification Gateway URLs” within the Domain Settings Overlay.

After that Setting is made, nexxOMNIA will automatically start to push a Notification to the defined URLs after every modification of every Media Item.

Ping Receiver

nexxOMNIA pushes the data structure as raw JSON via POST to the defined Endpoint. The Endpoint therefore should not take care of any REQUEST Variable, instead take the complete REQUEST Data and interpret it as JSON.

A simple example for a PHP Backend would be:

$pingdata = json_decode(file_get_contents(“php://input”),TRUE)

Besides some Metadata, the Payload offers the "data" Object. Here you find the complete Metadata of the Media Item. This Object is rbasically a Representation of a successful API Call withadditionalfields=all and addPublishingDetails=1. If the Notification occurred due to an Export Event, the Parameter addExportDetails=1 is internally applied for a more convenient Representation of the current Export States.

Ping Data Structure

Key

Property

Desription

trigger

event

the "reason" for this Trigger

user

the User ID, that changed the Media Item (or 0, if created by nexxOMNIA)

session

the Session ID, that changed the Media Item (or 0, if created by nexxOMNIA)

created

the Timestamp of the Change

sent

the Timestamp of the Trigger Processing

secret

the computed Secret for Comparison (if enabled)

item

ID

the ID of the Media Item

GID

the GlobalID of the Media Item

refnr

the external Reference of the Media Item

domain

the Domain of the Media Item

streamtype

the Streamtpe of the Media Item

data

API Result

Per default, each Notification Gateway will receive ALL Events. If you are only interested in some of them, the Notification Gateway Settings allows to restrict the Event Reasons to only those, you are interested in.

Ping Event Triggers

Reason

Description

encoded

the Item has been encoded for a Gateway

thumb

the URL of a Cover attribute has been changed

caption

the associated Caption Files have been changed

metadata

the general Metadata of the Item has been modified

connecteditems

the similar Elements / Recommendation Elements have been changed

expired

the Media Item has reached the time, where it should deactivate itself.

deactivate

the Media Item has been deactivated (or deactivated itself)

delete

the Media Item has been deleted (or deleted itself)

archive

the Media Item has been archived

restore

the Media Item was deleted/deactivated/archived, but has been restored

tocoldstorage

the Media Item was moved to cold Storage

fromcoldstorage

the Media Item was moved from cold Storage

approved

the Media Item was approved by API or a Approval Process

claimed

the Media Item was UGC, but has been claimed by the API or an Approval Process

rejected

the Media Item was rejected by API or a Approval Process

newversion

the Media Item has been updated with a new file

childrenchanged

on a Container Item, the Child Elements have been changed

linkhasdata

on Live Items, the connected Source receives Input Data

linkhasnodata

on Live Items, the connected Source does not receive Input Data anymore

exportcompleted

an Export to a third-Party Platform has been completed successfully.

exportupdated

an Export to a third-Party Platform has been updated successfully.

exportdeleted

an Export to a third-Party Platform has been removed

Security

Per Default, the Ping will be sent raw to the Receivers. If necessary, a Security Check can be integrated. nexxOMNIA will show a "Secret" for each Notification Gateway. Each Ping contains a trigger.secret Attribute, which is the Result of

md5(item.ID,trigger.created,trigger.sent,SECRET)

As the Receiver should know the Value of SECRET, it is easy to verify, that this Ping was originally sent by nexxOMNIA.

Last updated