{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/webhooks/:id","auth":"required","params":[{"name":"active","type":"boolean","default":"false","desc":"Set the webhook as active or inactive","required":false,"in":"body","ref":"","_id":"5696f91c59a6692d003fad55"},{"name":"settings","type":"array_object","default":"","desc":"When to trigger the webhook","required":false,"in":"body","ref":"","_id":"5696f91c59a6692d003fad54"},{"name":"url","type":"string","default":"","desc":"The endpoint the webhook should hit","required":false,"in":"body","ref":"","_id":"5696f91c59a6692d003fad53"},{"name":"http_method","type":"string","default":"","desc":"The http method the webhook should use","required":false,"in":"body","ref":"","_id":"5696f91c59a6692d003fad52"},{"name":"name","type":"string","default":"","desc":"Name of the webhook","required":false,"in":"body","ref":"","_id":"5696f91c59a6692d003fad51"}],"results":{"codes":[{"status":200,"language":"json","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\"}","name":""}]},"settings":"","examples":{"codes":[{"language":"text","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\"}}'"}]},"method":"put"},"next":{"description":"","pages":[]},"title":"Update Webhook","type":"endpoint","slug":"update-webhook","excerpt":"","body":"","updates":[],"order":19,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5696f92c24490c3700170a2d","editedParams2":true,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55208138623ff50d009b2bf0","55494a226a82a10d00817ae5","55494ba7ee219b0d001743c8","55494bc1ee219b0d001743cc","56ead8c1df765617008bccaf","573a2073dd007d1700cf288f","579695b1f64c9f0e007cd76c","57969e3dfa1ff60e006a1274","579a4592fd9f3c0e008e4f4a","57ab9afe54fa780e006c5430","57b784f5b7ebd60e009cb4a6","58f686818193090f008cec76","59e79fbd4cf31900341d50c6","5b2436973fd93f0003dcf99d","5d824fb2ce98a801366098a2"],"_id":"55208137623ff50d009b2bef","createdAt":"2015-04-05T00:26:31.564Z","releaseDate":"2015-04-05T00:26:31.563Z","__v":15,"project":"55208137623ff50d009b2bec"},"__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":["55494ad0ee219b0d001743bb","55494b05f452670d00ec0c29","55494b11ee219b0d001743bf","55494b20ee219b0d001743c1","55494b2bee219b0d001743c3","55494b4a6a82a10d00817af5","55494b686a82a10d00817af9","5549651ccd09b317005f8f50","55497273cd09b317005f8f86","554977f0c634cf2d001250a7","55b970eab42b610d00c9b2e3","5696f3688560a60d00e2c216","5696f91c59a6692d003fad50","5696f92c24490c3700170a2d","5696f9700b09a41900b24422"],"title":"Public API","slug":"public-api","order":3,"from_sync":false,"reference":true,"_id":"55494a226a82a10d00817ae5","createdAt":"2015-05-05T22:54:26.925Z","project":"55208137623ff50d009b2bec","version":"55208137623ff50d009b2bef","__v":15},"editedParams":true,"githubsync":"","parentDoc":null,"user":"55208129504fd6230022ae20","createdAt":"2016-01-14T01:26:04.343Z","project":"55208137623ff50d009b2bec"}

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