{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/webhooks/:id","auth":"required","examples":{"codes":[{"language":"http","code":"PUT https://api.goformz.com/v2/webhooks/0596f81d-7b85-4ac2-8c10-30580c13b92a","name":""}]},"method":"put","params":[{"name":"id","type":"string","default":"","desc":"Id of the existing webhook to update","required":true,"in":"path","ref":"","_id":"56391f722fc5520d001a4d71"},{"name":"body","type":"object","default":"","desc":"Webhook object","required":true,"in":"body","ref":"","_id":"563922b5ec0f5d0d0085e7de"}],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Update an Existing Webhook","type":"endpoint","slug":"update-an-existing-webhook","excerpt":"","body":"Sample Request Body:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"0596f81d-7b85-4ac2-8c10-30580c13b92a\\\",\\n  \\\"eventType\\\": \\\"form.complete\\\",\\n  \\\"targetUrl\\\": \\\"http://my.webhooks.com/formComplete\\\",\\n  \\\"entityId\\\": \\\"28b3af03-6ae2-4a1c-9b01-a46c0108d3c5\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nThe `entityId` in the context of the `form.complete` event is the template id.\n\n</br><a href=\"https://api.goformz.com/docs/api/explorer/index#!/Webhooks/Webhooks_Put\" target=\"_blank\"><img src=\"https://files.readme.io/9Z82WIZnS7mZmco8oi4u_TryItNow3.png\" style=\"margin-left:15px\" width=\"128\" height=\"42\" ></a>","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56391f722fc5520d001a4d70","user":"55359b006dfbb90d003462b5","project":"55357364e02d480d0003c6d3","category":{"sync":{"isSync":false,"url":""},"pages":["563917851593e4190073a3dc","56391a7e1593e4190073a3e6","56391e7c2fc5520d001a4d6e","56391f722fc5520d001a4d70","563924a968b11f0d0048c9c0"],"title":"Webhooks","slug":"webhooks","order":10,"from_sync":false,"reference":false,"_id":"5639113f049e420d00476b03","createdAt":"2015-11-03T19:55:43.923Z","project":"55357364e02d480d0003c6d3","__v":5,"version":"553591cd63cc650d00312925"},"githubsync":"","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","releaseDate":"2015-04-20T23:54:53.134Z","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z"},"__v":1,"createdAt":"2015-11-03T20:56:18.058Z","editedParams":true,"editedParams2":true,"parentDoc":null}

putUpdate an Existing Webhook


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
Id of the existing webhook to update

Body Params

body:
required
object
Webhook object

Examples


Documentation

Sample Request Body: [block:code] { "codes": [ { "code": "{\n \"id\": \"0596f81d-7b85-4ac2-8c10-30580c13b92a\",\n \"eventType\": \"form.complete\",\n \"targetUrl\": \"http://my.webhooks.com/formComplete\",\n \"entityId\": \"28b3af03-6ae2-4a1c-9b01-a46c0108d3c5\"\n}", "language": "json" } ] } [/block] The `entityId` in the context of the `form.complete` event is the template id. </br><a href="https://api.goformz.com/docs/api/explorer/index#!/Webhooks/Webhooks_Put" target="_blank"><img src="https://files.readme.io/9Z82WIZnS7mZmco8oi4u_TryItNow3.png" style="margin-left:15px" width="128" height="42" ></a>