{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/webhooks/{webhookId}","auth":"required","examples":{"codes":[{"code":"curl -X \"PUT\" \"https://s2-api.safestream.com/2.0/webhooks/{id}\" \\\n     -H \"Content-Type: application/json\" \\\n     -H \"x-api-key: [[app:apiKey]]\" \\\n     -H \"x-api-client-id: [[app:apiClientId]]\" \\\n     -d $'{\n  \"transport\": \"http\",\n  \"transportProperties\": {\n    \"endpoint\": \"https://whatsup.com\"\n  }\n}'\n","language":"curl"}]},"method":"put","results":{"codes":[{"name":"","code":"{\n  \"id\": \"bxxxx4-xxxf-4xxxx-8xxxxx-exxxx5dxxxx74\",\n  \"domainId\": \"530xxx7-fxxxx-4xxx-axxx-0d7exxxxxxx\",\n  \"transport\": \"http\",\n  \"transportProperties\": {\n    \"endpoint\": \"https://whatsup.com\"\n  },\n  \"createdBy\": \"79xxxxx-xxd72-xxxx-axxx-xxxxxx1805\",\n  \"createdOn\": 1521572508000,\n  \"updatedBy\": \"79xxxxx-xxd72-xxxx-axxx-xxxxxx1805\",\n  \"updatedOn\": 1521572546000\n}\n","language":"json","status":200},{"name":"","code":"{ message: [Array of error messages] }","language":"json","status":400},{"code":"{\n  \"message\": \"Access Denied\"\n}","language":"json","status":401},{"language":"json","status":403,"code":"{\n  \"message\": \"Access Denied\"\n}"}]},"settings":"","params":[{"name":"eventBinding","type":"string","default":"null","desc":"If this field is not specified all account specific events will be sent, please see Event Bindings section below for more details","required":false,"in":"body","ref":"","_id":"568a7b50bf86800d00fe310c"},{"name":"transport","type":"string","default":"\"transport\": \"http\"","desc":"Determines how to connect to the specified endpoint given in the transportProperties","required":true,"in":"body","ref":"","_id":"568a7bd18360c00d00a0e72b"},{"name":"transportProperties","type":"array_object","default":"\"transportProperties\": {       \"endpoint\": \"https://whatsup.com\"     }","desc":"Contains the endpoint that the desired event will be sent to","required":true,"in":"body","ref":"","_id":"568a7c40d4e2360d0098002b"},{"name":"filter","type":"array_object","default":"\"filter\" : {\"myFilter\" : [\"filter1\", \"filter2\"]}","desc":"Desired filters for the webhook","required":false,"in":"body","ref":"","_id":"58248f95d90fa027009b2597"},{"name":"body","type":"string","default":"null","desc":"Metadata about the webhook","required":false,"in":"body","ref":"","_id":"5acb8da83990fe0003bc52d4"}]},"next":{"description":"","pages":[]},"title":"Update Webhook","type":"endpoint","slug":"update-webhook","excerpt":"Update an existing webhook","body":"[block:api-header]\n{\n  \"title\": \"Event Bindings\"\n}\n[/block]\n**video.create**  - This event is fired when a new video is ingested into SafeStream\n\n**watermark.job.create**  - This event is fired when a request for video watermarking is received *via a POST to /watermark*","updates":[],"order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ae326a34adae4000365cb1e","project":"5669937dfc5abf2300afe7de","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59796d1140a3a2001f068cb5","59796d1140a3a2001f068cb6","59796d1140a3a2001f068cb7","59796d1140a3a2001f068cb8","5acb7bc606a2ce0003f28da4"],"_id":"59796d1140a3a2001f068cb4","project":"5669937dfc5abf2300afe7de","createdAt":"2017-07-27T04:33:21.278Z","releaseDate":"2017-07-27T04:33:21.278Z","__v":2},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Webhooks","slug":"webhooks","order":9999,"from_sync":false,"reference":false,"_id":"5acb7bc606a2ce0003f28da4","project":"5669937dfc5abf2300afe7de","version":"59796d1140a3a2001f068cb4","createdAt":"2018-04-09T14:42:14.106Z","__v":0},"user":"599b4786eac604000fedaf43","createdAt":"2018-04-27T13:33:23.935Z","githubsync":"","__v":4}

putUpdate Webhook

Update an existing webhook

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

eventBinding:
stringnull
If this field is not specified all account specific events will be sent, please see Event Bindings section below for more details
transport:
required
string"transport": "http"
Determines how to connect to the specified endpoint given in the transportProperties
transportProperties:
required
array of objects"transportProperties": { "endpoint": "https://whatsup.com" }
Contains the endpoint that the desired event will be sent to
filter:
array of objects"filter" : {"myFilter" : ["filter1", "filter2"]}
Desired filters for the webhook
body:
stringnull
Metadata about the webhook

Examples


Result Format


Documentation

[block:api-header] { "title": "Event Bindings" } [/block] **video.create** - This event is fired when a new video is ingested into SafeStream **watermark.job.create** - This event is fired when a request for video watermarking is received *via a POST to /watermark*

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}