{"_id":"582789abbe5c080f00a5a80c","parentDoc":null,"version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"__v":1,"category":{"_id":"582789abbe5c080f00a5a807","project":"568bdc1483d2061900d86cdc","__v":0,"version":"582789aabe5c080f00a5a7fe","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T20:31:45.696Z","from_sync":false,"order":15,"slug":"webhooks","title":"Webhooks"},"project":"568bdc1483d2061900d86cdc","user":"573b7f42fdc9d320001b777d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T20:52:20.524Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":" ","name":""},{"status":400,"language":"json","code":"{\n  \"errorType\": \"InvalidParams\",\n  \"errors\": [\n    {\n      \"in\": \"body\",\n      \"message\": \"url did not match ^(?:https?:\\\\/\\\\/)?.+\\\\..+\\\\..+?(?:\\\\/.+)*$\",\n      \"path\": \"url\"},\n    {\n      \"in\": \"body\",\n      \"message\": \"expected field to be a string\",\n      \"path\": \"url\"\n    }\n  ]\n}","name":""},{"status":401,"language":"text","code":""},{"code":"","status":403,"language":"text"},{"status":404,"language":"text","code":"Webhook with id 573cdb450224330956ae2a2e does not exist."}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"language":"http","code":"PUT https://ioe.droplit.io/api/webhooks/573cdb450224330956ae2a2d HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n  \"url\": \"http://iot.example.com/droplit\",\n  \"secret\": \"xyzzy\",\n  \"description\": \"My IOT server\",\n  \"disabled\": true\n}"}]},"method":"put","auth":"required","params":[{"_id":"573ce2dd5601c20e00a9049e","ref":"","in":"path","required":true,"desc":"webhook id","default":"","type":"string","name":"id"},{"_id":"573ce2dd5601c20e00a9049d","ref":"","in":"body","required":false,"desc":"address of the HTTP callback","default":"","type":"string","name":"url"},{"_id":"58d0873cba22ef0f0051503d","ref":"","in":"body","required":false,"desc":"a secret token that may be used to secure the webhook","default":"","type":"string","name":"secret"},{"_id":"573ce2dd5601c20e00a9049c","ref":"","in":"body","required":false,"desc":"a description for the webhook","default":"","type":"string","name":"description"},{"_id":"573ce2dd5601c20e00a9049b","ref":"","in":"body","required":false,"desc":"whether or not the webhook is disabled","default":"","type":"boolean","name":"disabled"}],"url":"/webhooks/:id"},"isReference":true,"order":3,"body":"","excerpt":"Update webhook information","slug":"update-webhooks","type":"endpoint","title":"Update"}

putUpdate

Update webhook information

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
webhook id

Body Params

url:
string
address of the HTTP callback
secret:
string
a secret token that may be used to secure the webhook
description:
string
a description for the webhook
disabled:
boolean
whether or not the webhook is disabled

Examples


Result Format


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 }}