{"_id":"5696f92c24490c3700170a2d","editedParams2":true,"version":{"_id":"55208137623ff50d009b2bef","__v":14,"project":"55208137623ff50d009b2bec","createdAt":"2015-04-05T00:26:31.564Z","releaseDate":"2015-04-05T00:26:31.563Z","categories":["55208138623ff50d009b2bf0","55494a226a82a10d00817ae5","55494ba7ee219b0d001743c8","55494bc1ee219b0d001743cc","56ead8c1df765617008bccaf","573a2073dd007d1700cf288f","579695b1f64c9f0e007cd76c","57969e3dfa1ff60e006a1274","579a4592fd9f3c0e008e4f4a","57ab9afe54fa780e006c5430","57b784f5b7ebd60e009cb4a6","58f686818193090f008cec76","59e79fbd4cf31900341d50c6","5b2436973fd93f0003dcf99d"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"category":{"_id":"55494a226a82a10d00817ae5","project":"55208137623ff50d009b2bec","version":"55208137623ff50d009b2bef","__v":15,"pages":["55494ad0ee219b0d001743bb","55494b05f452670d00ec0c29","55494b11ee219b0d001743bf","55494b20ee219b0d001743c1","55494b2bee219b0d001743c3","55494b4a6a82a10d00817af5","55494b686a82a10d00817af9","5549651ccd09b317005f8f50","55497273cd09b317005f8f86","554977f0c634cf2d001250a7","55b970eab42b610d00c9b2e3","5696f3688560a60d00e2c216","5696f91c59a6692d003fad50","5696f92c24490c3700170a2d","5696f9700b09a41900b24422"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-05-05T22:54:26.925Z","from_sync":false,"order":2,"slug":"public-api","title":"Public API"},"editedParams":true,"githubsync":"","parentDoc":null,"user":"55208129504fd6230022ae20","project":"55208137623ff50d009b2bec","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-14T01:26:04.343Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\"id\":2,\"active\":true,\"settings\":{\"new_assigned_message\":\"true\",\"new_unassigned_message\":\"true\"},\"url\":\"https://kittenland.com\",\"http_method\":\"POST\",\"payload\":\"\",\"name\":\"Meow Webhook1\",\"created_at\":\"2015-07-25T20:19:09.213-07:00\",\"updated_at\":\"2015-08-08T16:46:20.364-07:00\"}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"curl 'https://www.sendsonar.com/api/v1/webhooks/2' \\\n  -X PUT \\\n  -H 'X-Token:YOUR_TOKEN' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"webhook\": {\"name\": \"Cat\", \"active\": \"true\", \"settings\": {}, \"url\": \"http://meow.meow\", \"http_method\": \"POST\"}}'","language":"text"}]},"method":"put","auth":"required","params":[{"_id":"5696f91c59a6692d003fad55","ref":"","in":"body","required":false,"desc":"Set the webhook as active or inactive","default":"false","type":"boolean","name":"active"},{"_id":"5696f91c59a6692d003fad54","ref":"","in":"body","required":false,"desc":"When to trigger the webhook","default":"","type":"array_object","name":"settings"},{"_id":"5696f91c59a6692d003fad53","ref":"","in":"body","required":false,"desc":"The endpoint the webhook should hit","default":"","type":"string","name":"url"},{"_id":"5696f91c59a6692d003fad52","ref":"","in":"body","required":false,"desc":"The http method the webhook should use","default":"","type":"string","name":"http_method"},{"_id":"5696f91c59a6692d003fad51","ref":"","in":"body","required":false,"desc":"Name of the webhook","default":"","type":"string","name":"name"}],"url":"/webhooks/:id"},"isReference":true,"order":15,"body":"","excerpt":"","slug":"update-webhook","type":"endpoint","title":"Update Webhook"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

active:
booleanfalse
Set the webhook as active or inactive
settings:
array of objects
When to trigger the webhook
url:
string
The endpoint the webhook should hit
http_method:
string
The http method the webhook should use
name:
string
Name of the webhook

Examples


Result Format