Download Administrator's Guide

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 27 Current »

To set up a notification rule, proceed as follows:

  1. Select the "Notifications" entry in the navigation pane.

  2. Click the [Create] button at the top of the list of notifications.



  3. Select one of the following "Event" options from the drop-down menu:

    EventDescription
    Timed video release will expireAs soon as a timed video release expires, the configured action is triggered.
    Video uploadedAs soon as a new video is uploaded to your account, the configured action is triggered.
    Video changedThe configured action is triggered as soon as a video is changed in one of the following ways:
    • metadata (e.g. title, description, keywords, etc.)
    • security settings (e.g. release status, security policy, etc.)
    • moving a video to the trash or restoring a deleted video
    • a video has been replaced
    • a video was assigned to a channel or unlinked from a channel
    Channel changedThe configured action is triggered as soon as a channel changes in one of the following ways:
    • a new channel was created
    • a channel was deleted
    • a channel name has been changed
    • the owner group of a channel has been changed.
    Monthly reportAt the end of each month (last day of a calendar month), a monthly report is sent to the specified e-mail addresses. The following information is available in this report:
    • traffic generated by each group
    • storage used by each group
    Social media publicationThe configured action is triggered as soon as a video publish to a social media profile is initiated (Facebook or YouTube).


  4. Select one of the following "Action" options from the drop-down menu:

    ActionDescription
    Send email to addressWhen the selected event occurs, an email will be sent to the registered email address.
    You can also set the language of the notification (see step 5).
    Call up URL with GETWhen the selected event occurs, the specified URL will be called up. API developers can use this to trigger events within their own API.
    Call up URL with POST

    When the selected event occurs, information regarding the selected event is passed in a JSON-file to the specified URL. API developers can use this data within their own API. Each POST will send an event object containing some standard data and some values specific to the type of event. Use the list below to reveal a sample response for each event type:

    {
    	"videoManagerId": 174,
    	"videoManagerName": "Company Videos",
    	"eventExecutionTime": 1466422467227,
    	"eventType": "PUBLISH_PERIOD_EXPIRES",
    	"videoId": "CPfMCAuS5U78C4eshAaBWV",
    	"periodEnd": 1417089466985,
    	"editorEmail": ""
    }
    {
    	"videoManagerId": 174,
    	"videoManagerName": "Company Videos",
    	"eventExecutionTime": 1466422467227,
    	"eventType": "VIDEO_UPLOADED",
    	"videoId": "CPfMCAuS5U78C4eshAaBWV",
    	"fileName": "video.mp4",
    	"editorEmail": "example@movingimage.com"
    }
    {
    	"videoManagerId": 174,
    	"videoManagerName": "Company Videos",
    	"eventExecutionTime": 1466422467227,
    	"eventType": "VIDEO_CHANGED",
    	"videoId": "CPfMCAuS5U78C4eshAaBWV",
    	"fields": ["TITLE","DESCRIPTION"],
    	"editorEmail": ""
    }
    {
    	"videoManagerId": 174,
    	"videoManagerName": "Company Videos",
    	"eventExecutionTime": 1466422467227,
    	"eventType": "CHANNEL_CHANGED",
    	"changeType": "VIDEOS_ADDED",
    	"channelId": 54,
    	"channelName": "Promo",
    	"videoIds": ["CPfMCAuS5U78C4eshAaBWV","7PfMCAuS5U78C4eshAaBWV"],
    	"editorEmail": ""
    }
    {
    	"trafficBooked": 500,
    	"monthTraffic": 8.270144462585449e-7,
    	"storageAllotment": 500,
    	"storageUsed": 345,
    	"groupTraffic": [
    		{
    			"id": 1,
    			"name": "Company",
    			"traffic": 2.0675361156463623e-7,
    			"storage": 22
    		},
    		{
    			"id": 2,
    			"name": "Marketing",
    			"traffic": 2.0675361156463623e-7,
    			"storage": 33
    		},
    		{
    			"id": 3,
    			"name": "Documentation",
    			"traffic": 4.1350722312927246e-7,
    			"storage": 55
    		}
    	],
    	"editorEmail": ""
    }
    {
    	"videoManagerId": 174,
    	"videoManagerName": "Company Videos",
    	"eventExecutionTime": 1503589879686,
    	"eventType": "SOCIAL_MEDIA_PUBLISH",
    	"videoId": "CPfMCAuS5U78C4eshAaBWV",
    	"socialMediaType": "FACEBOOK",
    	"publicationProfileName": "Company Facebook Profile",
    	"editorEmail": "example@movingimage.com"
    }

    Note that the "editorEmail" will return an empty string unless the "User Email" toggle in the "Include User Information" field is enabled (it defaults to off). The "editorEmail" string will also always be empty for certain event types that aren't initiated by a user (e.g. monthly reports). See the Editing a Notification Rule chapter for more information.

  5. If you have selected an email notification, you can choose the language for this notification in the drop-down menu.



  6. Click the [Create] button. This creates the notification rule and displays it in the list.

    To enable the notification rule, you must configure the options in the notification edit pane (see "Editing a Notification Rule").