{"_id":"59c7e07a57bd8200105444dd","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c7dfa457bd8200105444dc","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-24T16:39:00.936Z","from_sync":false,"order":16,"slug":"webhooks-api","title":"Webhooks API"},"user":"58cc41f21751ce2f003be3b7","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-24T16:42:34.428Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"59a85bd52bdf3600193d4fd5","results":{"codes":[]},"examples":{"codes":[]},"method":"post","auth":"required","params":[{"_id":"59c7e07a57bd8200105444e1","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"ecosystemId"},{"_id":"59c7e07a57bd8200105444e0","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"url"},{"_id":"59c7e07a57bd8200105444df","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"secret"},{"_id":"59c7e07a57bd8200105444de","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"description"}],"url":"/"},"isReference":false,"order":1,"body":"Details\n\nCreate a webhook.\n\nAn account token or server token may be used to run this endpoint.\n\n# Parameters\n\n## body\n\n- ecosystemId (required): The ID of the ecosystem.\n- url (required): The URL of the webhook.\n- secret (optional): A secret token which can be used to secure the webhook.\n- description (optional): The description of the webhook.\n\n# Responses\n\n## 201\n\n- {\n    \"id\": \"WEBHOOK-ID\",\n    \"desription\": \"WEBHOOK-DESCRIPTION\",\n    \"ecosystemId\": \"ECOSYSTEM-ID\",\n    \"url\": \"CALLBACK-URL\",\n    \"disabled\": IS-DISABLED,\n    \"createdAt\": \"YYYY-MM-DD HH:MM:SS ENCODED\"\n}\n\n## 400\n\n- __Body Parameters Missing:__ The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.”\n- __Ecosystem Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid.\n- __Ecosystem Missing:__ The standard error structure defines this error as both an invalid parameter name and a missing parameter. In this context, it means that the parameter which is used to specify an ecosystem ID is not present.\n- __Webhook Callback Invalid:__ This error means that the URI for the webhook callback was not formatted properly.\n- __Webhook Callback Missing:__ The standard error structure defines this error as invalid parameters. In this context, it means that the URL for a webhook callback is missing, and was required.\n\n## 404\n\n- __Ecosystem Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does.\n\n# Examples\n\n## HTTP\n\n```\nPOST https://ioe.droplit.io/api/webhooks HTTP/1.1\nauthorization: TOKEN\ncontent-type: application/json\n{\n    \"ecosystemId\": \"ECOSYSTEM-ID\",\n    \"url\": \"CALLBACK-URL\"\n}\n```\n\n## Droplit Console\n\n```\ndroplit webhook create CALLBACK-URL --ecosystemId ECOSYSTEM-ID\n```","excerpt":"","slug":"webhooks-create","type":"endpoint","title":"Create a webhook."}

postCreate a webhook.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

ecosystemId:
required
string
url:
required
string
secret:
string
description:
string

Documentation

Details Create a webhook. An account token or server token may be used to run this endpoint. # Parameters ## body - ecosystemId (required): The ID of the ecosystem. - url (required): The URL of the webhook. - secret (optional): A secret token which can be used to secure the webhook. - description (optional): The description of the webhook. # Responses ## 201 - { "id": "WEBHOOK-ID", "desription": "WEBHOOK-DESCRIPTION", "ecosystemId": "ECOSYSTEM-ID", "url": "CALLBACK-URL", "disabled": IS-DISABLED, "createdAt": "YYYY-MM-DD HH:MM:SS ENCODED" } ## 400 - __Body Parameters Missing:__ The standard error structure defines this error as invalid parameters, and contains all required body parameters. If this error occurs when the JSON structure of the body parameters is syntactically correct, this means that the “content-type” header is incorrectly specified. The content-type header should be “application/json.” - __Ecosystem Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid. - __Ecosystem Missing:__ The standard error structure defines this error as both an invalid parameter name and a missing parameter. In this context, it means that the parameter which is used to specify an ecosystem ID is not present. - __Webhook Callback Invalid:__ This error means that the URI for the webhook callback was not formatted properly. - __Webhook Callback Missing:__ The standard error structure defines this error as invalid parameters. In this context, it means that the URL for a webhook callback is missing, and was required. ## 404 - __Ecosystem Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does. # Examples ## HTTP ``` POST https://ioe.droplit.io/api/webhooks HTTP/1.1 authorization: TOKEN content-type: application/json { "ecosystemId": "ECOSYSTEM-ID", "url": "CALLBACK-URL" } ``` ## Droplit Console ``` droplit webhook create CALLBACK-URL --ecosystemId ECOSYSTEM-ID ```

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