This is the Wildmoka external APIs description and documentation.
\nFor all the APIs, the headers date and authorization are used to do the HMAC authentication.
\nFor the following APIs, a unique error format is used.
\nSo in case of errors (HTTP status code different than a 2xx), the following fields should be returned:
\nCreate an event using the fields that are in the event definition.
\nOnly the following fields should be given:
\nname: string; the display name of the eventdescription: string (optional); the description of the event.thumbnail: source: string (optional, enum[\"clip_id\", \"url\"])value: string (optional and depends on the source)tags: string (optional), list of tags separated by a commaexposition: date: UTC JSON Date (optional)duration: integer (optional, default: 0, unlimited if 0)stream: type: string (optional, default: \"id\", enum[\"id\", \"pool\"])value: string (should be a stream_id if type == \"id\" if type == \"pool\")test_start: UTC JSON Date (optional); if set, tests (to verify connections, etc.) should start at this dateedito_start: UTC JSON Date; the edito start date is when the live event should be covered by editosedito_stop: UTC JSON Date; the edito end date is when the live event should stop.stop: UTC JSON Date; the stop date is when the event should be stoppednotif_email: string (optional); if set, future notifications before start and before stop may be sent to this emailclip_creation_at_end : boolean (optional, default: false); ; if true a real clip is created at the end of the event, and can be accessed in the CMS viewclip_publication_at_end : boolean (optional, default: false); if true a real clip is created, published at the end of the event, and can be accessed in the CMS viewclip_template: integer (optional); the template to apply to the clip created at the end of livelive_publication: boolean (optional, default: false)live: (mandatory if live_publication is true)type: string (optional, default: passtrough, can be : editable_one_to_manyor editable_many_to_many or passtrough)template: integer; the template id to apply to the live.auto_announce: UTC JSON Date (optional); if set, event will be auto announce at the specified datestart_edito_manual: boolean (optional, default: false); if set to true, the live will NOT automatically enter in start phase when the event reaches the edito_start datestop_edito_manual: boolean (optional, default: false); if set to true, the live will NOT automatically terminate when the event reaches the stop dateSee the full body example below for the list of all authorized fields.
\nReturns an event as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","event"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[]}},"response":[{"id":"ab7c8dbb-0888-4916-b190-99086123d911","name":"200 - Creation of an Event with full automation of a Live","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"my event name\",\n \"stream\" : {\n \t\"type\": \"id\",\n \t\"value\": 987456321\n },\n \"exposition\": {\n \t\"date\": \"2017-05-23T20:25:43.511Z\",\n \"duration\": 10\n },\n \"tags\": \"tag1, tag2, tag3\",\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"clip_creation_at_end\" : false,\n \"notif_email\" : \"hello@mycompany.com\",\n \"live_publication\": true,\n \"live\" : {\n \t\"type\":\"editable_one_to_many\",\n \t\"template\": 852789,\n \t\"auto_announce\": \"2017-04-22T18:25:43.511Z\",\n \t\"start_edito_manual\": false,\n \"stop_edito_manual\": false\n }\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"live_publication\": true,\n \"name\": \"my event name\",\n \"stream\": {\n \"tags\": [\n \"stream_tag1\",\n \"stream_tag2\"\n ],\n \"id\": 987456321,\n \"name\": \"My stream\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"test_start\": \"2017-04-23T20:25:43+02:00\",\n \"stop\": \"2017-04-23T20:25:43+00:00\",\n \"live\": {\n \"auto_announce\": \"2017-04-22T20:25:43+02:00\",\n \"start_edito_manual\": false,\n \"stop_edito_manual\": false,\n \"type\": \"editable_one_to_many\",\n \"id\": 261747,\n \"template\": {\n \"type\": \"live\",\n \"id\": 852789,\n \"name\": \"Template Live\"\n }\n },\n \"profiles\": [\n {\n \"id\": 2,\n \"name\": \"Admin Profile\"\n }\n ],\n \"id\": 261746,\n \"clip_creation_at_end\": false,\n \"thumbnail\": {\n \"url\": null,\n \"clip_id\": null\n },\n \"state\": \"pending\",\n \"notif_email\": \"hello@mycompany.com\",\n \"exposition\": {\n \"date\": \"2017-05-23T20:25:43.511Z\",\n \"duration\": 10\n },\n \"edito_start\": \"2017-04-23T19:25:43+00:00\",\n \"description\": \"\"\n}"},{"id":"c9fd6ca7-3d17-4637-9fd3-466614eafeba","name":"200 - Creation of a simple Event (with no live nor automation of stream activation)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"my event name\",\n \"stream\" : {\n \t\"type\": \"id\",\n \t\"value\": 987456321\n },\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"notif_email\" : \"hello@mycompany.com\",\n \"clip_creation_at_end\" : false\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"live_publication\": false,\n \"name\": \"my event name\",\n \"stream\": {\n \"tags\": [\n \"stream_tag1\",\n \"stream_tag2\"\n ],\n \"id\": \"987456321\",\n \"name\": \"My stream\"\n },\n \"tags\": [\n \"\"\n ],\n \"test_start\": \"2017-04-23T20:25:43+02:00\",\n \"stop\": \"2017-04-23T20:25:43+00:00\",\n \"profiles\": [\n {\n \"id\": 2,\n \"name\": \"Admin Profile\"\n }\n ],\n \"id\": 261750,\n \"clip_creation_at_end\": false,\n \"thumbnail\": {\n \"url\": null,\n \"clip_id\": null\n },\n \"state\": \"pending\",\n \"notif_email\": \"hello@mycompany.com\",\n \"exposition\": {\n \"date\": null,\n \"duration\": 0\n },\n \"edito_start\": \"2017-04-23T19:25:43+00:00\",\n \"description\": \"\"\n}"},{"id":"ca78f9ba-968f-45cc-804f-0daa34dde050","name":"400 - Error creating an Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"my event name\",\n \"stream\": { \n \t\"type\": \"id\",\n \t\"value\" : 987456321\n },\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"notif_email\" : \"my_notif_email\",\n \"clip_creation_at_end\" : false\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"date\": \"2017-04-23T20:25:43.511Z\",\n \"message\": \"Event object format invalid (notif_email: Enter a valid email address.)\"\n}"}],"_postman_id":"7f0498a7-68d4-44d4-9ada-06bac41c06df"},{"name":"Find Events","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"2367cca0-8cb2-4c81-946c-557b6563cd0c","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event?name=EVENT_NAME&start_after=A_DATE&stop_before=ANOTHER_DATE","description":"List all events filtered by:
\nThe date range is limited to a 2-months period.\nIf both start and stop dates are not given, it will be from now to now plus 2 months.\nElse, if only one start or stop date is given, the range will cover a 2-months range.
\nReturns a filtered list of events.\nEach event should be rendered as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","event"],"host":["{{sub_domain}}","wildmoka","com"],"query":[{"key":"name","value":"EVENT_NAME"},{"key":"start_after","value":"A_DATE"},{"key":"stop_before","value":"ANOTHER_DATE"}],"variable":[]}},"response":[{"id":"068d7e16-4de0-4acc-ae9a-feadd8afb8a7","name":"200 - Find Events filtered by name \"my event name\"","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eAPIs/1.0/event?name=my event name","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eAPIs","1.0","event"],"query":[{"key":"name","value":"my event name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": [\n {\n \"live_publication\": true,\n \"name\": \"my event name\",\n \"stream\": {\n \"tags\": [\n \"stream_tag1\",\n \"stream_tag2\"\n ],\n \"id\": 987456321,\n \"name\": \"My stream\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\"\n ],\n \"test_start\": \"2017-04-23T20:25:43+02:00\",\n \"stop\": \"2017-04-23T20:25:43+00:00\",\n \"live\": {\n \"auto_announce\": \"2017-04-22T20:25:43+02:00\",\n \"start_edito_manual\": false,\n \"stop_edito_manual\": false,\n \"type\": \"editable_one_to_many\",\n \"id\": 261747,\n \"template\": {\n \"type\": \"live\",\n \"id\": 852789,\n \"name\": \"Template Live\"\n }\n },\n \"profiles\": [\n {\n \"id\": 2,\n \"name\": \"Admin Profile\"\n }\n ],\n \"id\": 261746,\n \"clip_creation_at_end\": false,\n \"thumbnail\": {\n \"url\": null,\n \"clip_id\": null\n },\n \"state\": \"pending\",\n \"notif_email\": \"hello@mycompany.com\",\n \"exposition\": {\n \"date\": \"2017-05-23T20:25:43.511Z\",\n \"duration\": 10\n },\n \"edito_start\": \"2017-04-23T19:25:43+00:00\",\n \"description\": \"\"\n }\n ]\n}"},{"id":"5d7bbf74-3466-4653-b8dd-5c926bb349c3","name":"200 - Empty Event list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event?name=not_existing_name","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event"],"query":[{"key":"name","value":"not_existing_name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": []\n}"}],"_postman_id":"2367cca0-8cb2-4c81-946c-557b6563cd0c"},{"name":"Get an Event by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"37c5b414-b855-45d9-9acd-127aaa009232","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID","description":"Get an event description from ID.
\nReturns an event as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","event",":eventID"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"c7dbf038-fee6-4e1f-9792-26353ae2869f","type":"any","value":"12345","key":"eventID"}]}},"response":[{"id":"b5bedb73-46f8-4679-8659-2bf22f686a93","name":"200 - Get an Event","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID"],"variable":[{"key":"eventID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 987454123,\n \"name\": \"my event name\",\n \"stream_id\": 987456321,\n \"profiles\": [\n 9879658\n ],\n \"auto_start\": true,\n \"auto_stop\": true,\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"notif_email\": \"hello@mycompany.com\",\n \"clip_creation_at_end\": false,\n \"live\": {\n \"id\": 74123,\n \"type\": \"editable_one_to_many\",\n \"template\": 852789,\n \"auto_anounce\": \"2017-04-21T20:25:43.511Z\",\n \"start_edito_manual\": false,\n \"stop_edito_manual\": false\n },\n \"state\": \"started\",\n \"life_cycle_status\": {\n \"changeStateAsync\": {\n \"status\": \"error\",\n \"message\": \"State can not be changed to pending\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n },\n \"a_possible_internal_error\": {\n \"status\": \"error\",\n \"message\": \"The internal error message is message\",\n \"stack\": \"The exception is due to an internal error\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n }\n }\n}"},{"id":"5ebd5c5c-a66a-4b6c-aa27-bfdf3327b30f","name":"404 - Error due to nonexistent Event","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID"],"variable":[{"key":"eventID","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"Event not found for id xxx\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"}],"_postman_id":"37c5b414-b855-45d9-9acd-127aaa009232"},{"name":"Update of an existing Event State (Asynchronous)","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"827aa90f-a5ad-499f-9207-c9a160e2b086","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"requested_state\" : \"started\"\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/changeStateAsync","description":"As described, an event has 4 states, that go in consecutive order:
\nWhen an event is \"started\", the content of the event is stored for the retention time set in your tenant.
\nA \"started\" event can be stopped once and a \"stopped\" event can't be started again.
\nReturns an event as defined.
\nBEWARE, update of an existing event state is asynchronous.\nThe state of the event should be checked getting the existing event on which state should have been updated.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","event",":eventID","changeStateAsync"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"110e4e61-f304-4720-9da7-c07e0ed4b598","description":{"content":"The Event ID we got from Event creation or find
\n","type":"text/plain"},"type":"any","value":"12345","key":"eventID"}]}},"response":[{"id":"22c84fc1-dd35-4420-98a0-fbfe63accd8e","name":"200 - Update of an existing Event state","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requested_state\" : \"started\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/changeStateAsync","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID","changeStateAsync"],"variable":[{"key":"eventID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 987454123,\n \"name\": \"my event name\",\n \"stream_id\": 987456321,\n \"auto_start\": true,\n \"auto_stop\": true,\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"notif_email\": \"hello@mycompany.com\",\n \"clip_creation_at_end\": false,\n \"state\": \"pending\",\n \"life_cycle_status\": {\n \"changeStateAsync\": {\n \"status\": \"pending\"\n }\n }\n}"},{"id":"55f98315-08c4-4ab2-b6c2-3674899d9e2a","name":"400 - Error due to state change impossible","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requested_state\" : \"started\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/changeStateAsync","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID","changeStateAsync"],"variable":[{"key":"eventID","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"State can not be changed to started\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"},{"id":"fb08dc9f-3267-4e4e-86e8-7079c8f5524b","name":"200 - Update of an existing Event state","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requested_state\" : \"started\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/changeStateAsync","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID","changeStateAsync"],"variable":[{"key":"eventID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 987454123,\n \"name\": \"my event name\",\n \"stream_id\": 987456321,\n \"profiles\": [\n 9879658\n ],\n \"auto_start\": true,\n \"auto_stop\": true,\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"notif_email\": \"hello@mycompany.com\",\n \"clip_creation_at_end\": false,\n \"state\": \"pending\",\n \"life_cycle_status\": {\n \"changeStateAsync\": {\n \"status\": \"pending\"\n }\n }\n}"}],"_postman_id":"827aa90f-a5ad-499f-9207-c9a160e2b086"},{"name":"Update of an Event","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"e44d4dbf-7e53-4040-b6f0-555b1359490a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"my event name\",\n \"description\": \"My event description\",\n \"thumbnail\": {\n \"source\": \"clip_id\",\n \"value\": 1234567\n },\n \"tags\": \"tag1, tag2, tag3\",\n \"exposition\": {\n \"date\": \"2017-05-23T20:25:43.511Z\",\n \"duration\": 10\n },\n \"stream\": {\n \"type\" : \"id\",\n \"value\": 987456321\n },\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"notif_email\" : \"hello@mycompany.com\",\n \"clip_creation_at_end\" : true,\n \"clip_template\": 85256,\n \"live_publication\": true,\n \"live\" : {\n \"type\":\"editable_one_to_many\",\n \"template\": 852789,\n \"auto_announce\": \"2017-04-21T18:25:43.511Z\",\n \"start_edito_manual\": false,\n \"stop_edito_manual\": false\n }\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID","description":"Depending on the event state only some values can be updated. Nevertheless the whole event structure has to be provided.
\nIf the event is \"pending\", all the following fields can be updated
\nname: string; the display name of the eventdescription: string (optional); the description of the event.thumbnail: source: string (optional, enum[\"clip_id\", \"url\"])value: string (optional and depends on the source)tags: string (optional), list of tags separated by a commaexposition: date: UTC JSON Date (optional)duration: integer (optional, default: 0, unlimited if 0)stream: type: string (optional, default: \"id\", enum[\"id\", \"pool\"])value: string (should be a stream_id if type == \"id\" if type == \"pool\")test_start: UTC JSON Date (optional); if set, tests (to verify connections, etc.) should start at this dateedito_start: UTC JSON Date; the edito start date is when the event should be covered by editosstop: UTC JSON Date; the stop date is when the event should be stoppednotif_email: string (optional); if set, future notifications before start and before stop may be sent to this emailclip_creation_at_end : boolean (optional, default: false); ; if true a real clip is created at the end of the event, and can be accessed in the CMS viewclip_publication_at_end : boolean (optional, default: false); if true a real clip is created, published at the end of the event, and can be accessed in the CMS viewclip_template: integer (optional); the template to apply to the clip created at the end of livelive_publication: boolean (optional, default: false)live: (mandatory if live_publication is true)type: string (optional, default: passtrough)template: integer; the template id to apply to the live.auto_announce: UTC JSON Date (optional); if set, event will be auto announce at the specified datestart_edito_manual: boolean (optional, default: false); if set to true, the live will NOT automatically enter in start phase when the event reaches the edito_start datestop_edito_manual: boolean (optional, default: false); if set to true, the live will NOT automatically terminate when the event reaches the stop dateIf the event state is \"testing\" or \"live\" only the following fields can be updated
\nThe Event ID we got from Event creation or find
\n","type":"text/plain"},"type":"any","value":"12345","key":"eventID"}]}},"response":[{"id":"34190b46-6449-4d06-ad84-bf6e7b807f9e","name":"200 - Update of an existing Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"my event new name\",\n \"description\": \"My event other description\",\n \"thumbnail\": {\n \t\"source\": \"clip_id\",\n\t\"value\": 1234567\n },\n \"tags\": \"tag1, tag2, tag3, tag4\",\n \"exposition\": {\n \t\"date\": \"2017-05-23T20:25:43.511Z\",\n \t\"duration\": 10\n },\n \"stream\": {\n \t\"type\" : \"id\",\n \t\"value\": 987456321\n },\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"notif_email\" : \"hello@mycompany.com\",\n \"clip_creation_at_end\" : false,\n \"live_publication\": true,\n \"live\" : {\n \"type\":\"editable_one_to_many\",\n \"auto_announce\": \"2017-04-21T18:25:43.511Z\",\n \"start_edito_manual\": false,\n \"stop_edito_manual\": false\n }\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/changeStateAsync","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID","changeStateAsync"],"variable":[{"key":"eventID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 547961,\n \"name\": \"my event name\",\n \"description\": \"My event description\",\n \"thumbnail\": {\n \"clip_id\": 132456789,\n \"url\": \"https://static.wildmoka.com/image.jpg\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\",\n \"tag3\",\n \"tag4\"\n ],\n \"exposition\": {\n \"date\": \"2017-05-23T20:25:43.511Z\",\n \"duration\": 10\n },\n \"stream\": {\n \"id\": 987456321,\n \"name\": \"Stream Name\"\n },\n \"profiles\": [\n {\n \"name\": \"Admin\",\n \"id\": 541236980\n },\n {\n \"name\": \"Editor\",\n \"id\": 541236989\n }\n ],\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"state\": \"pending\",\n \"notif_email\": \"hello@mycompany.com\",\n \"clip_creation_at_end\": false,\n \"live_publication\": true,\n \"live\": {\n \"id\": 123657,\n \"type\": \"editable_one_to_many\",\n \"auto_announce\": \"2017-04-22T18:25:43.511Z\",\n \"start_edito_manual\": true,\n \"stop_edito_manual\": true\n }\n}"}],"_postman_id":"e44d4dbf-7e53-4040-b6f0-555b1359490a"},{"name":"Assign Event to Profiles","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"8f80dda7-23d0-4f22-b151-edf93182ae8e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"requested_profiles\" : [9879658, 6546325]\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/assignToProfiles","description":"Assign profiles to an event.\nEach profile assigned to Event will be able to view/edit/delete the Event.
\nReturns an event as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","event",":eventID","assignToProfiles"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"5370dfd6-13fe-4fc2-b0ce-cf7f8163f018","description":{"content":"The Event ID we got from Event creation or find
\n","type":"text/plain"},"type":"any","value":"12345","key":"eventID"}]}},"response":[{"id":"be87d710-b2a4-47b3-a8e8-9b7fa9fa3cde","name":"200 - Update Profiles of an existing Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requested_profiles\" : [9879658, 6546325]\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/assignToProfile","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID","assignToProfile"],"variable":[{"key":"eventID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 987454123,\n \"name\": \"my event name\",\n \"stream_id\": 987456321,\n \"profiles\": [\n 9879658,\n 6546325\n ],\n \"auto_start\": true,\n \"auto_stop\": true,\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"notif_email\": \"hello@mycompany.com\",\n \"clip_creation_at_end\": false,\n \"state\": \"pending\",\n \"life_cycle_status\": {\n \"changeStateAsync\": {\n \"status\": \"pending\"\n }\n }\n}"}],"_postman_id":"8f80dda7-23d0-4f22-b151-edf93182ae8e"},{"name":"Delete an Event by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"98c89546-8aab-4985-a53d-fda9d98a4c4e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/delete","description":"Delete an event.
\nThis operation is only possible on an event in \"pending\" state.
\nReturns id of the deleted event and a 200 HTTP status code in case of success.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","event",":eventID","delete"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"ffb6d151-d256-4869-8ecc-6aca9bafe8ee","description":{"content":"The Event ID we got from Event creation or find
\n","type":"text/plain"},"type":"any","value":"12345","key":"eventID"}]}},"response":[{"id":"d86bcd51-ec8d-4f1d-a9a2-c71d69811a99","name":"200 - Deletion of an Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/delete","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID","delete"],"variable":[{"key":"eventID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n\t\"id\": 987454123\n}"},{"id":"f6265783-daef-4108-a6fa-6ba1a28e6f1b","name":"404 - Error due to nonexistent Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/delete","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID","delete"],"variable":[{"key":"eventID","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"Event not found for id xxx\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"}],"_postman_id":"98c89546-8aab-4985-a53d-fda9d98a4c4e"}],"id":"93f6819d-b6c1-49b1-ada6-4adafe636eb7","description":"An event is an object allowing to define a time range on a stream, add schedule action around it.
\nAn event is primarily defined by 3 UTC timestamps:
\nthe first one defines the start of the testing phase of the event, to check if the streams are ok,
\nthe next one defines the \"real\" start of the event, for edition, etc.,
\nthe last one is the end of the event itself.
\nAn event has 4 states, that go in consecutive order: pending, testing, started and stopped when an event is started the content of the event is stored for the retention time set in your tenant. A started event can be stopped once and a stopped event can't be started again.
A live can be associated to an event (to schedule a facebook live for example). In that case, a publishing template can be set, and automation of the live lifecycle enforced.
\nAn event is defined by the following fields:
\nid: integer; the id of the created event
name: string; the display name of the event
description: string, the description of the event.
thumbnail:
clip_id: integer, the id of the clip decorator
url: string, the external url of the thumbnail (Not supported yet)
tags: list of string.
stream:
id: integer; the id of the stream on which clipping will be possible
name: string, the display name of the stream
tags: list of string.
exposition:
date: UTC JSON Date.
duration: integer, number of exposition days after exposition date. unlimited if 0.
profiles: list of JSON Objects; the list of profile ids and their name that have view/edit/delete permissions on the event
test_start: UTC JSON Date (optional); if set, tests (to verify connections, etc.) should start at this date
edito_start: UTC JSON Date; the edito start date is when the event should be covered by editos
edito_stop : UTC JSON Date; the edito end date is when the live event should stop.
stop: UTC JSON Date; the stop date is when the event should be stopped
notif_email: string (optional); if set, future notifications before start and before stop may be sent to this email
clip_creation_at_end : boolean; if true a real clip is created at the end of the event, and can be accessed in the CMS view
clip_publication_at_end : boolean; if true a real clip is created at the end of the event, and can be accessed in the CMS view
clip_template: JSON Object (optional); the template to apply to the clip created at the end of live
id: integer, the template id.
name: string; the display name of the template
type: string, the type of the template
state: string; the state of the stream: pending / testing / started / stopped
live_publication: boolean
live (optional): an object with the following fields
id: integer; the id of the created live
type: string (optional, default: passthrough); the type of live (passthrough / editable_one_to_many / editable_many_to_many)
publish_status: string; one of the possible live status (same possibles values than life_cycle_status.status)
template:
id: integer, the template id.
name: string; the display name of the template
type: string, the type of the template
auto_announce: UTC JSON Date (optional); if set, event will be auto announce at the specified date
start_edito_manual: boolean (optional, default: false); if set to True, the live will NOT automatically enter in start phase when the event reaches the start edito date
stop_edito_manual: boolean (optional, default: false); if set to True, the live will NOT automatically terminate when the event reaches the stop edito date
life_cycle_status: JSON Object (optional); a map of the last life cycle changes of the event (if in pending or in error state). Each changes can be described with the following fields:
status: string; the status of the change (pending / error)
message: string; a message that describes the situation
date: UTC JSON Date; the date of the change
This data structure is also sent by the webhook as a payload.
\nPossible webhook event types:
\ncreate : Creation of the event
\nupdate : Event has been updated
\nlive_publish_update : Live attached to this event has its publish status updated
\nList all the streams filtered by:
\nstarted / stoppedReturns a filtered list of streams.\nEach stream is rendered as the defined stream state.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","stream"],"host":["{{sub_domain}}","wildmoka","com"],"query":[{"description":{"content":"OPTIONAL : stream name to be found
\n","type":"text/plain"},"key":"name","value":"STREAM_NAME"},{"description":{"content":"OPTIONAL : can be \"started\" or \"stopped\"
\n","type":"text/plain"},"key":"state","value":"STREAM_STATE"}],"variable":[]}},"response":[{"id":"bd54c16a-9181-4725-b07b-97e7ca1b05cc","name":"200 - List Streams filtered by name \"my_stream\"","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eAPIs/1.0/stream/find?name=my_stream","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eAPIs","1.0","stream","find"],"query":[{"key":"name","value":"my_stream"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": [\n {\n \"id\": 987456321,\n \"name\": \"my_stream\",\n \"state\": \"stopped\",\n \"status\": \"error\"\n },\n {\n \"id\": 874521,\n \"name\": \"my_stream\",\n \"state\": \"started\",\n \"status\": \"ok\"\n }\n ]\n}"},{"id":"11edac8a-4d21-4c0a-9cc0-c5126b9414c4","name":"200 - Empty Streams list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/stream?name=STREAM_NAME&state=STREAM_STATE","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","stream"],"query":[{"key":"name","value":"STREAM_NAME","description":"OPTIONAL : stream name to be found"},{"key":"state","value":"STREAM_STATE","description":"OPTIONAL : can be \"started\" or \"stopped\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": []\n}"}],"_postman_id":"ac46c872-ee2d-46bd-a1ce-5c13c94b311b"},{"name":"Get a Stream State","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"1525e334-2f45-4042-8a09-c3220f8585c6","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/stream/:streamID/status","description":"Get the stream state from the ID of the stream.
\nReturns a stream state as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","stream",":streamID","status"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"0829dc09-aae8-474b-8f26-89900b401b8c","type":"any","value":"987456321","key":"streamID"}]}},"response":[{"id":"046871a5-409d-4ac2-a5c2-53fcf1b481a6","name":"404 - Error due to non existent Stream","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/stream/:streamID/status","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","stream",":streamID","status"],"variable":[{"key":"streamID","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"Stream not found for id xxx\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"},{"id":"062a72b4-13c4-43f3-b818-af79a695cb45","name":"200 - Get of a Stream status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eAPIs/1.0/stream/:streamID/status","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eAPIs","1.0","stream",":streamID","status"],"variable":[{"key":"streamID","value":"3254"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 987456321,\n \"name\": \"my_first stream\",\n \"state\": \"started\",\n \"status\": \"error\",\n \"life_cycle_status\": {\n \"changeStateAsync\": {\n \"status\": \"error\",\n \"message\": \"State can not be changed to stopped\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n }\n }\n}"}],"_postman_id":"1525e334-2f45-4042-8a09-c3220f8585c6"},{"name":"Update of an existing Stream State (Asynchronous)","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"f3c39bd7-63ed-4c25-8443-42323f5b4f48","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n\t\"requested_state\": \"started\"\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/stream/:streamID/changeStateAsync","description":"Change the state of a stream: can be started or stopped.
Returns a stream state as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","stream",":streamID","changeStateAsync"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"0f299863-7d73-4677-8e21-7434b41ca111","type":"any","value":"987456321","key":"streamID"}]}},"response":[{"id":"e5ef300d-62ad-4fce-b740-0f554dabd1e3","name":"400 - Error due to state change impossible","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"requested_state\": \"started\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/stream/:streamID/changeStateAsync","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","stream",":streamID","changeStateAsync"],"variable":[{"key":"streamID","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"State can not be changed to started\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"},{"id":"9ab3c2bb-3b41-45cb-935b-fa1e578aceca","name":"200 - Update of an existing Stream state","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"requested_state\": \"started\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/stream/:streamID/changeStateAsync","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","stream",":streamID","changeStateAsync"],"variable":[{"key":"streamID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 987456321,\n \"name\": \"my_first stream\",\n \"state\": \"started\",\n \"status\": \"ok\",\n \"life_cycle_status\": {\n \"changeStateAsync\": {\n \"status\": \"pending\"\n }\n }\n}"}],"_postman_id":"f3c39bd7-63ed-4c25-8443-42323f5b4f48"}],"id":"9bafeffe-abde-4e9e-bd27-56223f0a9556","description":"A stream in wildmoka is an object defining a live video ingestion: a main and a backup input, a setup of ahead of time encoding profiles and other ingestion options.
\nA stream state is defined by the following fields:
\nid: integer; the id of the stream
name: string; the name of the stream
tags: list[string]; the list of tags for this stream
state: string; the state of the stream, can be started or stopped
status: string; the status of the stream, can be ok, error, TBD more cleanly
life_cycle_status (optional): a map of the last life cycle changes of the stream (if in pending or in error state). Each \"changes\" can be described with the following fields:
status: string; the status of the change (pending / error)message (optional): string; a message that describes the situationstack (optional): string; a stack that descibes the errordate: UTC JSON Date; the date of the changeList all templates filtered by:
\nReturns a filtered list of templates.\nEach template should be rendered as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","template"],"host":["{{sub_domain}}","wildmoka","com"],"query":[{"description":{"content":"can be \"live\", \"video\", \"animation\", \"image\"
\n","type":"text/plain"},"key":"type","value":"TEMPLATE_TYPE"},{"key":"name","value":"TEMPLATE_NAME"}],"variable":[]}},"response":[{"id":"6bfec968-25a7-4e54-8ef9-d8b3c384beaa","name":"200 - Find Templates filtered by \"live\" type and \"my_live\" name","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/template?type=live&name=my_live","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","template"],"query":[{"key":"type","value":"live","description":"can be \"live\", \"video\", \"animation\", \"image\" "},{"key":"name","value":"my_live"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": [\n {\n \"id\": 852789,\n \"name\": \"my_live\",\n \"type\": \"live\"\n },\n {\n \"id\": 85256,\n \"name\": \"my_live\",\n \"type\": \"live\"\n }\n ]\n}"}],"_postman_id":"dd706b99-50c8-461f-8d5a-2ce0e4386c81"}],"id":"967b9655-9db3-4c0d-9e86-b51f2c3198c3","description":"A template in wildmoka is an object that can be applied to a clip or a live.
\nIt defines all the publication endpoints, with their cutomizations, but also their decorations for the media to be applied.
\nAn template is defined by the following fields:
\nList all decorators filtered by:
\nReturns a filtered list of decorators.\nEach decorator should be rendered as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","decorator"],"host":["{{sub_domain}}","wildmoka","com"],"query":[{"key":"type","value":"DECORATOR_TYPE"},{"key":"name","value":"DECORATOR_NAME"}],"variable":[]}},"response":[{"id":"60f0ee3d-4f42-4fe0-9d2f-6028eb68c802","name":"200 - Find Decorators filtered by \"image\" type and \"my_decorator\" name","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/decorator?type=image&name=my_decorator","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","decorator"],"query":[{"key":"type","value":"image"},{"key":"name","value":"my_decorator"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": [\n {\n \"id\": 74178621,\n \"name\": \"my_decorator\",\n \"type\": \"image\"\n },\n {\n \"id\": 8525412,\n \"name\": \"my_decorator\",\n \"type\": \"image\"\n }\n ]\n}"}],"_postman_id":"e451a07c-ccc2-44f7-bc7a-28ba98f401bc"}],"id":"de04c308-9523-4b46-8e3f-e35a6b330fb4","description":"Handle the decorators that can be applied to a clip or a live.
\nCan be a video, an image, some text, some filters, etc.
\nAn decorator is defined by the following fields:
\nList all profiles filtered by:
\nReturns a filtered list of profiles.\nEach profile should be rendered as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","profile"],"host":["{{sub_domain}}","wildmoka","com"],"query":[{"key":"name","value":"PROFILE_NAME"},{"key":"id","value":"ID"}],"variable":[]}},"response":[{"id":"afabcc3d-8468-4ef2-8ebf-8e02382bb773","name":"200 - Find Profiles starting by \"my_profile\" name","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/profile?name=my_profile","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","profile"],"query":[{"key":"name","value":"my_profile"},{"key":"id","value":"ID","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": [\n {\n \"id\": 9879658,\n \"name\": \"my_profile\"\n },\n {\n \"id\": 6546325,\n \"name\": \"my_profile\"\n }\n ]\n}"}],"_postman_id":"85ddbbba-549a-463c-a390-bf48b5247a01"}],"id":"bcfb6f47-2e9b-49a8-8989-ffc0ffba52d2","description":"Handle the profiles that can be applied to an object like an event or a live.
\nA profile is defined by the following fields:
\nCreate a live using fields that are in the live definition.
\nOnly the following fields should be given:
\nSee the full body example below for the list of all authorized fields.
\nReturns a live as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","live"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[]}},"response":[{"id":"ff7f96b7-326a-4f63-bad7-e8b3a38db1c8","name":"200 - Creation of a Live","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"title\":\"my live\",\n \"type\":\"editable_one_to_many\",\n \"template\": 054894788,\n \"auto_anounce\": \"2017-04-21T18:25:43.511Z\",\n \"stream_id\": 123\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 74123,\n \"title\": \"my live\",\n \"type\": \"editable_one_to_many\",\n \"template\": 852789,\n \"auto_anounce\": \"2017-04-21T18:25:43.511Z\",\n \"stream_id\": 987456321,\n \"profiles\": [\n 9879658\n ],\n \"state\": \"pending\",\n \"publications\": [\n {\n \"id\": 7417854,\n \"destination_type\": \"facebook\",\n \"destination_name\": \"My Page\",\n \"destination_id\": 14863456,\n \"state\": \"pending\"\n }\n ]\n}"},{"id":"f160dcdd-4b6a-4143-bba1-597cc126c99f","name":"400 - Error creating a Live","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"title\":\"my live\",\n \"type\":\"editable_one_to_one\",\n \"template\": 054894788,\n \"auto_anounce\": \"2017-04-21T18:25:43.511Z\",\n \"stream_id\": 123\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"Invalid type parameter\",\n \"stack\": \"Exception due to error\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"}],"_postman_id":"ea58563d-ce66-4dd8-8530-ef0657946d1b"},{"name":"Find active Lives","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"ed2428d2-b1d0-442d-aa23-dfec43d3860f","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live?state=LIVE_STATE","description":"List all lives filtered by:
\nReturns a filtered list of lives.\nEach live should be rendered as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","live"],"host":["{{sub_domain}}","wildmoka","com"],"query":[{"key":"state","value":"LIVE_STATE"}],"variable":[]}},"response":[{"id":"d7798bcd-0d17-4803-a09e-ad0f76e12f12","name":"200 - List Live filtered by \"testing\" state","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live?state=testing","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","live"],"query":[{"key":"state","value":"testing"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": [\n {\n \"id\": 74123,\n \"title\": \"my live\",\n \"type\": \"editable_one_to_many\",\n \"template\": 852789,\n \"auto_anounce\": \"2017-04-21T18:25:43.511Z\",\n \"stream_id\": 987456321,\n \"profiles\": [\n 9879658\n ],\n \"state\": \"testing\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n }\n },\n \"decorations\": [\n {\n \"id\": 123,\n \"decorator_id\": 74178621,\n \"state\": \"preview\",\n \"start\": 2,\n \"duration\": 6,\n \"values\": {\n \"text\": \"a first text\"\n },\n \"destination\": 14863456\n }\n ],\n \"publications\": [\n {\n \"id\": 234,\n \"destination_type\": \"facebook\",\n \"destination_name\": \"My Page\",\n \"destination_id\": 14863456,\n \"state\": \"testing\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n }\n }\n }\n ]\n },\n {\n \"id\": 741,\n \"title\": \"my live 2\",\n \"type\": \"editable_many_to_many\",\n \"template\": 85256,\n \"auto_anounce\": \"2017-04-22T18:25:43.511Z\",\n \"stream_id\": 874521,\n \"profiles\": [\n 9879658\n ],\n \"state\": \"testing\",\n \"publications\": [\n {\n \"id\": 567,\n \"destination_type\": \"twitter\",\n \"destination_name\": \"My Twittos\",\n \"destination_id\": 541523,\n \"state\": \"testing\"\n }\n ]\n }\n ]\n}"},{"id":"479610bb-cc0a-4edc-939a-7e818589aff0","name":"200 - Empty Lives list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live?state=LIVE_STATE","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","live"],"query":[{"key":"state","value":"LIVE_STATE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"items\": []\n}"}],"_postman_id":"ed2428d2-b1d0-442d-aa23-dfec43d3860f"},{"name":"Get a Live by ID","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"e8187feb-44c1-4caf-81a6-fff7ffdd433c","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID","description":"Get a live description from an ID.
\nReturns a live as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","live",":liveID"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"353aeb72-4872-44f0-9b9d-06e92818f444","type":"any","value":"74123","key":"liveID"}]}},"response":[{"id":"040fd6d5-7f2b-4e6c-ad2c-466c3cb90ea8","name":"200 - Get of a Live object","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eAPIs/1.0/live/:liveID","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eAPIs","1.0","live",":liveID"],"variable":[{"key":"liveID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 74123,\n \"title\": \"my live\",\n \"type\": \"editable_many_to_many\",\n \"template\": 852789,\n \"auto_anounce\": \"2017-04-21T18:25:43.511Z\",\n \"stream_id\": 987456321,\n \"profiles\": [\n 9879658\n ],\n \"state\": \"testing\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n }\n },\n \"decorations\": [\n {\n \"id\": 123,\n \"decorator_id\": 74178621,\n \"state\": \"hidden\",\n \"start\": 0,\n \"duration\": 0,\n \"values\": {\n \"color\": \"#03030300\"\n },\n \"destination\": \"all\"\n },\n {\n \"id\": 456,\n \"decorator_id\": 8525412,\n \"state\": \"preview\",\n \"start\": 2,\n \"duration\": 6,\n \"values\": {\n \"text\": \"a first text\"\n },\n \"destination\": 14863456\n },\n {\n \"id\": 789,\n \"decorator_id\": 8525412,\n \"state\": \"live\",\n \"start\": 2,\n \"duration\": 6,\n \"values\": {\n \"text\": \"a second text\"\n },\n \"destination\": 541523\n }\n ],\n \"publications\": [\n {\n \"id\": 234,\n \"destination_type\": \"facebook\",\n \"destination_name\": \"My Page\",\n \"destination_id\": 14863456,\n \"state\": \"testing\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n },\n \"liveError\": {\n \"status\": \"error\",\n \"message\": \"Message of the error is message\",\n \"date\": \"2017-04-22T18:25:43.511Z\"\n }\n }\n },\n {\n \"id\": 567,\n \"destination_type\": \"RTMP\",\n \"destination_name\": \"\",\n \"destination_id\": 541523\n }\n ]\n}"},{"id":"da11af87-862c-4f27-b00f-8a62ec5badfb","name":"404 - Error due to nonexistent Live","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"category\": {\n \"id\": 0,\n \"name\": \"string\"\n },\n \"name\": \"doggie\",\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","live",":liveID"],"variable":[{"key":"liveID","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"Live not found for id xxx\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"}],"_postman_id":"e8187feb-44c1-4caf-81a6-fff7ffdd433c"},{"name":"Update of an existing Live State (Asynchronous)","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"bba5a5d7-4d0a-4246-8585-976bd978cbb7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n\t\"requested_state\": \"testing\"\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID/changeStateAsync","description":"As described, a live has 4 states, that go in consecutive order:
\nA live can also be \"announced\" on the social networks, as defined by the \"auto_announce\" date field at live creation.
\nReturns a live as defined.
\nBEWARE, update of an existing live state is asynchronous.\nState of the live should be checked getting the existing live on which state should have been updated.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","live",":liveID","changeStateAsync"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"53938c1f-89bf-40dc-ae92-2311efd0b37a","type":"any","value":"74123","key":"liveID"}]}},"response":[{"id":"54fd7180-8c74-4179-981d-346bcd4368b0","name":"400 - Error due to state change already in progress on the Live","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"requested_state\": \"testing\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID/changeStateAsync","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","live",":liveID","changeStateAsync"],"variable":[{"key":"liveID","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"State change already in progress\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"},{"id":"8aab366e-3e88-4234-92bc-4825db813e23","name":"200 - Update of an existing Live State (Asynchronous)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"requested_state\": \"testing\"\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID/changeStateAsync","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","live",":liveID","changeStateAsync"],"variable":[{"key":"liveID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 123456,\n \"title\": \"my live\",\n \"type\": \"editable_many_to_many\",\n \"template\": 54894788,\n \"auto_anounce\": \"2017-04-21T18:25:43.511Z\",\n \"stream_id\": 94957,\n \"profiles\": [\n 9879658\n ],\n \"state\": \"pending\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n }\n },\n \"publications\": [\n {\n \"id\": 234,\n \"destination_type\": \"facebook\",\n \"destination_name\": \"My Page\",\n \"destination_id\": 8658656,\n \"state\": \"pending\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n }\n }\n }\n ]\n}"}],"_postman_id":"bba5a5d7-4d0a-4246-8585-976bd978cbb7"},{"name":"Assign Live to Profiles","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"e0734fd3-9ad6-4c90-8740-09d6b56fe526","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"requested_profiles\" : [9879658, 6546325]\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/assignToProfiles","description":"Assign profiles to an live.\nEach profile assigned to live will be able to view/edit/delete the live.
\nReturns an live as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","event",":eventID","assignToProfiles"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"af9472b7-7eee-4c3a-893d-ffacbeb1366d","description":{"content":"The Event ID we got from Event creation or find
\n","type":"text/plain"},"type":"any","value":"12345","key":"eventID"}]}},"response":[{"id":"f8cf17e2-f5ff-4c26-9ba2-c1c91b54dc61","name":"200 - Update Profiles of an existing Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"requested_profiles\" : [9879658, 6546325]\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/event/:eventID/assignToProfile","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","event",":eventID","assignToProfile"],"variable":[{"key":"eventID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 74123,\n \"title\": \"my live\",\n \"type\": \"editable_many_to_many\",\n \"template\": 852789,\n \"auto_anounce\": \"2017-04-21T18:25:43.511Z\",\n \"stream_id\": 987456321,\n \"profiles\": [\n 9879658,\n 6546325\n ],\n \"state\": \"testing\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n }\n },\n \"decorations\": [\n {\n \"id\": 123,\n \"decorator_id\": 74178621,\n \"state\": \"hidden\",\n \"start\": 0,\n \"duration\": 0,\n \"values\": {\n \"color\": \"#03030300\"\n },\n \"destination\": \"all\"\n },\n {\n \"id\": 456,\n \"decorator_id\": 8525412,\n \"state\": \"preview\",\n \"start\": 2,\n \"duration\": 6,\n \"values\": {\n \"text\": \"a first text\"\n },\n \"destination\": 14863456\n },\n {\n \"id\": 789,\n \"decorator_id\": 8525412,\n \"state\": \"live\",\n \"start\": 2,\n \"duration\": 6,\n \"values\": {\n \"text\": \"a second text\"\n },\n \"destination\": 541523\n }\n ],\n \"publications\": [\n {\n \"id\": 234,\n \"destination_type\": \"facebook\",\n \"destination_name\": \"My Page\",\n \"destination_id\": 14863456,\n \"state\": \"testing\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n },\n \"liveError\": {\n \"status\": \"error\",\n \"message\": \"Message of the error is message\",\n \"date\": \"2017-04-22T18:25:43.511Z\"\n }\n }\n },\n {\n \"id\": 567,\n \"destination_type\": \"RTMP\",\n \"destination_name\": \"\",\n \"destination_id\": 541523\n }\n ]\n}"}],"_postman_id":"e0734fd3-9ad6-4c90-8740-09d6b56fe526"},{"name":"Add decorations to a Live","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"76302f3b-76dd-475e-9838-6d74f113f5e9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n\t\"decorations\": [\n\t\t{\n\t\t\t\"decorator_id\": 74178621,\n\t\t\t\"state\": \"hidden\",\n\t\t\t\"start\": 0.0,\n\t\t\t\"duration\": 0.0,\n\t\t\t\"values\" : {\n\t\t\t \"color\": \"#03030300\"\n\t\t\t},\n\t\t\t\"destination\": \"all\"\n\t\t},\n\t\t{\n\t\t\t\"decorator_id\": 8525412,\n\t\t\t\"state\": \"preview\",\n\t\t\t\"start\": 2.0,\n\t\t\t\"duration\": 6.0,\n\t\t\t\"values\": {\n\t\t\t \"text\": \"a first text\"\n\t\t\t},\n\t\t\t\"destination\": 14863456\n\t\t}, \n\t\t{\n\t\t\t\"decorator_id\": 9636523,\n\t\t\t\"state\": \"live\",\n\t\t\t\"start\": 2.0,\n\t\t\t\"duration\": 6.0,\n\t\t\t\"values\": {\n\t\t\t \"text\": \"a second text\"\n\t\t\t},\n\t\t\t\"destination\": 541523\n\t\t} \n\t]\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID/addDecoration","description":"Add some decorations to the live using the following fields:
\nReturns a list of decorations with ids that can be manipulated: hidden, shown, previewed.
\nThe \"destination\" (ids) seen in the example can be retrieved trough the \"Get a Live by ID\"; \"all\" means it will be applied to all destinations.
\nBEWARE: only the live type \"editable_many_to_many\" supports a decorators per destination.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","live",":liveID","addDecoration"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"32f03f55-c675-46ce-8c6a-450e51094072","type":"any","value":"74123","key":"liveID"}]}},"response":[{"id":"824dc1bd-38d7-4fe7-98a2-887ab69953d5","name":"200 - Add decorations to a Live","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"decorations\": [\n {\n \"decorator_id\": 74178621,\n \"state\": \"hidden\",\n \"start\": 0.0,\n \"duration\": 0.0,\n \"values\" : {\n \"color\": \"#03030300\"\n },\n \"destination\": \"all\"\n },\n {\n \"decorator_id\": 8525412,\n \"state\": \"preview\",\n \"start\": 2.0,\n \"duration\": 6.0,\n \"values\": {\n \"text\": \"a first text\"\n },\n \"destination\": 14863456\n }, \n {\n \"decorator_id\": 9636523,\n \"state\": \"live\",\n \"start\": 2.0,\n \"duration\": 6.0,\n \"values\": {\n \"text\": \"a second text\"\n },\n \"destination\": 541523\n } \n ]\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID/addDecoration","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","live",":liveID","addDecoration"],"variable":[{"key":"liveID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"decorations\": [\n {\n \t\"id\": 123,\n \t\"decorator_id\": 74178621,\n \t\"state\": \"hidden\",\n \t\"start\": 0.0,\n\t\t\"duration\": 0.0,\n\t\t\"values\" : {\n\t\t\t\"color\": \"#03030300\"\n\t\t},\n\t\t\"destination\": \"all\"\n },\n {\n \t\"id\": 456,\n\t\t\"decorator_id\": 8525412,\n\t\t\"state\": \"preview\",\n\t\t\"start\": 2.0,\n\t\t\"duration\": 6.0,\n\t\t\"values\": {\n\t\t\t\"text\": \"a first text\"\n\t\t},\n\t\t\"destination\": 14863456\n }, \n {\n \t\"id\": 789,\n\t\t\"decorator_id\": 9636523,\n\t\t\"state\": \"live\",\n\t\t\"start\": 2.0,\n\t\t\"duration\": 6.0,\n\t\t\"values\": {\n\t\t\t\"text\": \"a second text\"\n\t\t},\n\t\t\"destination\": 541523\n } \n ]\n}"},{"id":"4abd34c7-7dd0-4aa2-adf9-d1928300f786","name":"404 - Error due to nonexistent Decorator","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"decorations\": [\n\t\t{\n\t\t\t\"decorator_id\": 6789,\n\t\t\t\"state\": \"hidden\",\n\t\t\t\"start\": 0.0,\n\t\t\t\"duration\": 0.0,\n\t\t\t\"values\" : {\n\t\t\t \"color\": \"#03030300\"\n\t\t\t},\n\t\t\t\"destination\": \"all\"\n\t\t},\n\t\t{\n\t\t\t\"decorator_id\": 3456,\n\t\t\t\"state\": \"preview\",\n\t\t\t\"start\": 2.0,\n\t\t\t\"duration\": 6.0,\n\t\t\t\"values\": {\n\t\t\t \"text\": \"a first text\"\n\t\t\t},\n\t\t\t\"destination\": 345\n\t\t}, \n\t\t{\n\t\t\t\"decorator_id\": 3456,\n\t\t\t\"state\": \"live\",\n\t\t\t\"start\": 2.0,\n\t\t\t\"duration\": 6.0,\n\t\t\t\"values\": {\n\t\t\t \"text\": \"a second text\"\n\t\t\t},\n\t\t\t\"destination\": 346\n\t\t} \n\t]\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID/addDecoration","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","live",":liveID","addDecoration"],"variable":[{"key":"liveID","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"error\",\n \"message\": \"Decorator not found for id xxx\",\n \"date\": \"2017-04-23T20:25:43.511Z\"\n}"}],"_postman_id":"76302f3b-76dd-475e-9838-6d74f113f5e9"},{"name":"Change decorations State in Live","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"f8cd8cb3-3819-4c9a-80f5-51fe839c0b16","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":"{\n \"decorations\":[\n {\n \"id\": 123,\n \"state\": \"hidden\"\n },\n {\n \"id\": 456,\n \"state\": \"preview\"\n }, \n {\n \"id\": 789,\n \"state\": \"live\"\n } \n ]\n}"},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID/changeDecorationState","description":"A given decoration can be:
\nChange the decorations state using the following fields:
\nReturns a live as defined.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","live",":liveID","changeDecorationState"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"95746844-b317-4940-99e7-28a03c932cbe","type":"any","value":"74123","key":"liveID"}]}},"response":[{"id":"cc4fac85-08f1-40f4-afad-7794a5f5f2d4","name":"200 - Change decorations State in Live","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"decorations\":[\n\t\t{\n\t\t\t\"id\": 123,\n\t\t\t\"state\": \"hidden\"\n\t\t},\n\t\t{\n\t\t\t\"id\": 456,\n\t\t\t\"state\": \"preview\"\n\t\t}, \n\t\t{\n\t\t\t\"id\": 789,\n\t\t\t\"state\": \"live\"\n\t\t} \n\t]\n}"},"url":{"raw":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/live/:liveID/changeDecorationState","protocol":"https","host":["{{sub_domain}}","wildmoka","com"],"path":["eapis","2.0","live",":liveID","changeDecorationState"],"variable":[{"key":"liveID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"id\": 123456,\n \"title\": \"my live\",\n \"type\": \"editable_many_to_many\",\n \"template\": 54894788,\n \"auto_anounce\": \"2017-04-21T18:25:43.511Z\",\n \"stream_id\": 94957,\n \"profiles\": [\n 9879658\n ],\n \"state\": \"pending\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n }\n },\n \"decorations\": [\n {\n \"id\": 123,\n \"decorator_id\": 456789,\n \"state\": \"hidden\",\n \"start\": 0,\n \"duration\": 0,\n \"values\": {\n \"color\": \"#03030300\"\n },\n \"destination\": \"all\"\n },\n {\n \"id\": 456,\n \"decorator_id\": 789123,\n \"state\": \"preview\",\n \"start\": 2,\n \"duration\": 6,\n \"values\": {\n \"text\": \"a first text\"\n },\n \"destination\": 234\n },\n {\n \"id\": 789,\n \"decorator_id\": 123456,\n \"state\": \"live\",\n \"start\": 2,\n \"duration\": 6,\n \"values\": {\n \"text\": \"a second text\"\n },\n \"destination\": 345\n }\n ],\n \"publications\": [\n {\n \"id\": 234,\n \"destination_type\": \"facebook\",\n \"destination_name\": \"My Page\",\n \"destination_id\": 8658656,\n \"state\": \"pending\",\n \"life_cycle_status\": {\n \"stateChangeAsync\": {\n \"status\": \"pending\"\n },\n \"liveError\": {\n \"status\": \"error\",\n \"message\": \"Message of the error is message\",\n \"date\": \"2017-04-22T18:25:43.511Z\"\n }\n }\n },\n {\n \"id\": 345,\n \"destination_type\": \"RTMP\",\n \"destination_name\": \"\",\n \"destination_id\": 97663\n }\n ]\n}"}],"_postman_id":"f8cd8cb3-3819-4c9a-80f5-51fe839c0b16"}],"id":"599b4a36-4048-436e-bec1-584b2a861c75","description":"Handle all the lives running in the platform.
\nTo create one live to be scheduled, create it through the event API and the live optional field.
\nA live is defined by the following fields:
\nEach \"life_cycle_status\" is an optional map of the last life cycle changes that has happened on the corresponding object (if in pending or in error state).
\nEach \"changes\" can be described with the following fields:
\nCreate or update a webhook.
\nOnly the following fields should be given:
\nList webhooks related to your account.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","webhook"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb3a9a30-7b6d-4d03-a6d5-f8803df0d20b"},{"name":"Webhook deletion","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var HMAC_helpers = eval(pm.globals.get(\"HMAC_helpers\"));\r","HMAC_helpers.make_headers();"]}}],"id":"644b2641-0822-4894-ba90-e8f467c70903","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"{{current-date}}"},{"key":"Authorization","value":"{{httpsig}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{sub_domain}}.wildmoka.com/eapis/2.0/webhook/:subscription_name/delete","description":"Delete a webhook.
\n","urlObject":{"protocol":"https","path":["eapis","2.0","webhook",":subscription_name","delete"],"host":["{{sub_domain}}","wildmoka","com"],"query":[],"variable":[{"id":"3da931ee-6c4c-48a3-957c-5e5fd68db188","type":"any","value":"mySubName","key":"subscription_name"}]}},"response":[],"_postman_id":"644b2641-0822-4894-ba90-e8f467c70903"}],"id":"0dd5290a-a5a3-422d-92f3-53f95755cc3c","description":"Webhooks can be created to be notified on events sent by our platform. Subscriptions are done on subjects that you want to be notified on, for example \"wildmoka/eapis/subject\", and can also be filtered by an event type on that subject.
\nWhen notified, the event body schema is as follow:
\n [\n {\n \"id\": \"XXXXXX\",\n \"eventType\": \"eventType\",\n \"subject\": \"wildmoka/eapis/<subject>\",\n \"eventTime\": \"2018-02-16T10:21:50+00:00\",\n \"data\": {\n \"hash\": TBD // Used to verify the authenticity of the data,\n \"trigger_by\": {\n \"type\": \"<eapis|ui|auto>\", // eapis : trigger by api call, ui : trigger by user interface, auto: trigger by wildmoka system\n \"user_id\": <userid_int> // ID of the user that initiates the fact the event triggers. (this key might be absent if \"auto\")\n }\n \"payload\": {\n /* Actual data for a wildmoka/eapis/event */\n }\n },\n \"dataVersion\": \"2.0\"\n }\n ]\n\nWhen you register your WebHook endpoint, it sends you a POST request with a simple validation code in order to prove endpoint ownership. Your app needs to respond by echoing back the validation code. Events won't be delivered to WebHook endpoints that have not passed the validation.
\nAt the time of event subscription creation/update, \"SubscriptionValidationEvent\" event is posted to the target endpoint.
\nThe event contains a header value \"Aeg-Event-Type: SubscriptionValidation\".
\nThe event body has the same schema as the one above.
\nThe event data includes a \"validationCode\" property with a randomly generated string. For example, \"validationCode: acb13…\".
\nAn example SubscriptionValidationEvent is shown in the following example:
\n [{\n \"id\": \"2d1781af-3a4c-4d7c-bd0c-e34b19da4e66\",\n \"topic\": \"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"subject\": \"\",\n \"data\": {\n \"validationCode\": \"512d38b6-c7b8-40c8-89fe-f46f9e9622b6\"\n },\n \"eventType\": \"Microsoft.EventGrid.SubscriptionValidationEvent\",\n \"eventTime\": \"2018-01-25T22:12:19.4556811Z\",\n \"metadataVersion\": \"1\",\n \"dataVersion\": \"1\"\n }]\n\nIn order to prove endpoint ownership, echo back the validation code in the validationResponse property, as shown in the following example:
\n {\n \"validationResponse\": \"512d38b6-c7b8-40c8-89fe-f46f9e9622b6\"\n }\n\nFinally, it is important to note that we only supports HTTPS webhook endpoints.
\nTo ensure a durable delivery, each message is sent at least once for each subscription. Events are sent to the registered webhook of each subscription immediately. If a webhook does not acknowledge receipt of an event within 60 seconds of the first delivery attempt, we retry a delivery of the event.
\nWe use an exponential backoff retry policy for event delivery. If your webhook does not respond or returns a failure code, we retry delivery on the following schedule:
\n10 seconds
\n30 seconds
\n1 minute
\n5 minutes
\n10 minutes
\n30 minutes
\n1 hour
\nFollowing the subject, the payload format is different.
\nThe payload contain data of the event created, updated or deleted:
\n { \n \"id\": 547961,\n \"name\": \"my event name\",\n \"description\": \"My event description\",\n \"thumbnail\": {\n \"clip_id\": 132456789,\n \"url\": \"https://static.wildmoka.com/image.jpg\"\n },\n \"tags\": [\"tag1\", \"tag2\", \"tag3\"],\n \"exposition\": {\n \"date\": \"2017-05-23T20:25:43.511Z\",\n \"duration\": 10\n },\n \"stream\": {\n \"id\" : 987456321,\n \"name\": \"Stream Name\"\n },\n \"profiles\": [\n { \n \"name\": \"Editor\", \n \"id\": 541236987\n }\n ],\n \"test_start\": \"2017-04-23T18:25:43.511Z\",\n \"edito_start\": \"2017-04-23T19:25:43.511Z\",\n \"stop\": \"2017-04-23T20:25:43.511Z\",\n \"state\": \"pending\",\n \"notif_email\" : \"hello@mycompany.com\",\n \"clip_creation_at_end\" : true,\n \"clip_template\": {\n \"id\": 85256,\n \"name\": \"My Template\",\n \"type\": \"video\"\n },\n \"live\" : {\n \"id\": 123657,\n \"type\":\"editable_one_to_many\",\n \"template\":{\n \"id\": 85259,\n \"name\": \"My Live Template\",\n \"type\": \"live\"\n },\n \"auto_announce\": \"2017-04-21T18:25:43.511Z\",\n \"start_edito_manual\": true,\n \"stop_edito_manual\": true\n }\n }\n\n