{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/","auth":"required","method":"post","examples":{"codes":[{"code":"POST https://ioe.droplit.io/api/webhooks HTTP/1.1\nauthorization: AUTH_TOKEN\nContent-Type: application/json\n\n{\n\t\"ecosystemId\": \"C5156b8ace57896adb6dae592\",\n\t\"url\": \"https://requestb.in/12rm425t\",\n\t\"secret\": \"superSecret\",\n\t\"description\": \"very descriptive\",\n  \"serviceNotificationSet\": false,\n  \"serviceNotificationInfo\": false\n}","language":"http"},{"name":"Droplit SDK - Example","language":"javascript","code":"droplit.webhooks.create(\"C5156b8ace57896adb6dae592\", \"https://requestb.in/12rm425t\", \"very descriptive\", \"superSecret\", 2, {\"set\" : false, \"info\" : false} );"},{"name":"Droplit SDK - Reference","language":"text","code":""}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\": \"5a96c7ea25087217c40a30c0\",\n    \"ecosystemId\": \"C5156b8ace57896adb6dae592\",\n    \"url\": \"https://requestb.in/12rm425t\",\n    \"secret\": \"superSecret\",\n    \"description\": \"very descriptive\",\n    \"disabled\": false,\n    \"createdAt\": \"2018-02-28T15:16:58.941Z\",\n    \"serviceNotificationsEnabled\": true,\n    \"dataNotificationsEnabled\": false,\n    \"serviceNotificationEvent\": true,\n    \"serviceNotificationGet\": true,\n    \"serviceNotificationSet\": false,\n    \"serviceNotificationCall\": true,\n    \"serviceNotificationChanged\": true,\n    \"serviceNotificationInfo\": false,\n    \"serviceNotificationError\": true,\n    \"dataNotificationCreated\": true,\n    \"dataNotificationUpdated\": true,\n    \"dataNotificationDeleted\": true,\n    \"version\": 2\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"message\": \"field is required\",\n            \"path\": \"url\"\n        }\n    ]\n}","name":"Body Parameters Missing"},{"name":"Ecosystem Invalid","status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"message\": \"invalid id\",\n            \"path\": \"ecosystemId\"\n        }\n    ]\n}"},{"name":"Webhook Callback Invalid","status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"message\": \"url did not match the pattern ^(?:https?:\\\\/\\\\/)?(?:.+\\\\.)?.+\\\\..+?(?:\\\\/.+)*$\",\n            \"path\": \"url\"\n        }\n    ]\n}"},{"name":"Ecosystem Not Found","status":404,"language":"text","code":"Ecosystem with id C59e88eae258a6bf402e39d21 does not exist."}]},"settings":"59a85bd52bdf3600193d4fd5","params":[{"name":"ecosystemId","type":"string","default":"","desc":"ID of the ecosystem in which the webhook will be created","required":true,"in":"body","ref":"","_id":"59c7e07a57bd8200105444e1"},{"name":"url","type":"string","default":"","desc":"The target URL of the webhook","required":true,"in":"body","ref":"","_id":"59c7e07a57bd8200105444e0"},{"name":"secret","type":"string","default":"","desc":"Key with which hashes are generated","required":false,"in":"body","ref":"","_id":"59c7e07a57bd8200105444df"},{"name":"description","type":"string","default":"","desc":"Brief description of webhook","required":false,"in":"body","ref":"","_id":"59c7e07a57bd8200105444de"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token","required":true,"in":"header","ref":"","_id":"5a96d01e89442e0020410ce0"},{"name":"Content-Type","type":"string","default":"","desc":"Specify that the sent data will be a JSON object.","required":true,"in":"header","ref":"","_id":"5a96d01e89442e0020410cdf"},{"name":"serviceNotificationsEnabled","type":"boolean","default":"true","desc":"Enables selective service notifications, otherwise disables ALL service notifications (even if any specific types are enabled).","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f88"},{"name":"dataNotificationsEnabled","type":"boolean","default":"false","desc":"Enables selective service notifications, otherwise disables ALL data notifications (even if some specific types are enabled).","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f87"},{"name":"serviceNotificationEvent","type":"boolean","default":"true","desc":"Notifies when any service notification is sent.","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f86"},{"name":"serviceNotificationGet","type":"boolean","default":"true","desc":"Notifies when a device's service property is accessed.","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f85"},{"name":"serviceNotificationSet","type":"boolean","default":"true","desc":"Notifies when a device's service property is set.","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f84"},{"name":"serviceNotificationCall","type":"boolean","default":"true","desc":"Notifies when a device's service method is called.","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f83"},{"name":"serviceNotificationChanged","type":"boolean","default":"true","desc":"Notifies when a device's service property is changed.","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f82"},{"name":"serviceNotificationInfo","type":"boolean","default":"true","desc":"","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f81"},{"name":"serviceNotificationError","type":"boolean","default":"true","desc":"Notifies when any error is detected.","required":false,"in":"body","ref":"","_id":"5ac4ec52bf58d30028807f80"},{"name":"dataNotificationCreated","type":"boolean","default":"true","desc":"Notifies when a device has been created.","required":false,"in":"body","ref":"","_id":"5ac4ed02f07fc000460046a6"},{"name":"dataNotificationUpdated","type":"boolean","default":"true","desc":"Notifies when a device's data has been updated.","required":false,"in":"body","ref":"","_id":"5ac4ed02f07fc000460046a5"},{"name":"dataNotificationDeleted","type":"boolean","default":"true","desc":"Notifies when a device has been deleted.","required":false,"in":"body","ref":"","_id":"5ac4ed02f07fc000460046a4"},{"name":"ecosystemNotificationsEnabled","type":"boolean","default":"true","desc":"The webhook will receive all notifications from its parent ecosystem.","required":false,"in":"body","ref":"","_id":"5cb6558f66617400101f1ba8"}]},"next":{"description":"","pages":[]},"title":"Create a webhook. v2","type":"endpoint","slug":"create-a-webhook-v2","excerpt":"","body":"Create a webhook.\n\nAn account token or server token may be used to run this endpoint.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"WARNING\",\n  \"body\": \"All optional parameters are not supported by the SDK during creation.\"\n}\n[/block]","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a96c701c777af00359e86b0","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Webhooks API","slug":"webhooks-api","order":27,"from_sync":false,"reference":false,"_id":"59c7dfa457bd8200105444dc","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-09-24T16:39:00.936Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-02-28T15:13:05.348Z","githubsync":"","__v":18,"parentDoc":null}

postCreate a webhook. v2


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

ecosystemId:
required
string
ID of the ecosystem in which the webhook will be created
url:
required
string
The target URL of the webhook
secret:
string
Key with which hashes are generated
description:
string
Brief description of webhook
serviceNotificationsEnabled:
booleantrue
Enables selective service notifications, otherwise disables ALL service notifications (even if any specific types are enabled).
dataNotificationsEnabled:
booleanfalse
Enables selective service notifications, otherwise disables ALL data notifications (even if some specific types are enabled).
serviceNotificationEvent:
booleantrue
Notifies when any service notification is sent.
serviceNotificationGet:
booleantrue
Notifies when a device's service property is accessed.
serviceNotificationSet:
booleantrue
Notifies when a device's service property is set.
serviceNotificationCall:
booleantrue
Notifies when a device's service method is called.
serviceNotificationChanged:
booleantrue
Notifies when a device's service property is changed.
serviceNotificationInfo:
booleantrue
serviceNotificationError:
booleantrue
Notifies when any error is detected.
dataNotificationCreated:
booleantrue
Notifies when a device has been created.
dataNotificationUpdated:
booleantrue
Notifies when a device's data has been updated.
dataNotificationDeleted:
booleantrue
Notifies when a device has been deleted.
ecosystemNotificationsEnabled:
booleantrue
The webhook will receive all notifications from its parent ecosystem.

Headers

authorization:
required
string
The user's authorization token
Content-Type:
required
string
Specify that the sent data will be a JSON object.

Examples


Result Format


Documentation

Create a webhook. An account token or server token may be used to run this endpoint. [block:callout] { "type": "warning", "title": "WARNING", "body": "All optional parameters are not supported by the SDK during creation." } [/block]

User Information

Try It Out

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