{ "opencollection": "1.0.0", "info": { "name": "Kaltura OTT accessControl eventNotificationTemplate API", "version": "3.6.287.20720" }, "items": [ { "info": { "name": "eventNotificationTemplate", "type": "folder" }, "items": [ { "info": { "name": "eventNotificationTemplate.add", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/add", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "This action allows for the creation of new backend event types in the system. This action requires access to the Kaltura server Admin Console. If you're looking to register to existing event types, please use the clone action instead." }, { "info": { "name": "eventNotificationTemplate.clone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/clone", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "This action allows registering to various backend event. Use this action to create notifications that will react to events such as new video was uploaded or metadata field was updated. To see the list of available event types, call the listTemplates action." }, { "info": { "name": "eventNotificationTemplate.delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/delete", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Delete an event notification template object" }, { "info": { "name": "eventNotificationTemplate.dispatch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/dispatch", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Dispatch event notification object by id" }, { "info": { "name": "eventNotificationTemplate.get", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/get", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Retrieve an event notification template object by id" }, { "info": { "name": "eventNotificationTemplate.list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/list", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "list event notification template objects" }, { "info": { "name": "eventNotificationTemplate.listByPartner", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/listByPartner", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] } }, { "info": { "name": "eventNotificationTemplate.listTemplates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/listTemplates", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Action lists the template partner event notification templates." }, { "info": { "name": "eventNotificationTemplate.register", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/register", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Register to a queue from which event messages will be provided according to given template. Queue will be created if not already exists" }, { "info": { "name": "eventNotificationTemplate.sendCommand", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/sendCommand", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Clear queue messages" }, { "info": { "name": "eventNotificationTemplate.update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/update", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update an existing event notification template object" }, { "info": { "name": "eventNotificationTemplate.updateStatus", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/eventnotification_eventnotificationtemplate/action/updateStatus", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update event notification template status by id" } ] } ], "bundled": true }