{"_id":"59c7e454791ca600105b9750","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:59:00.710Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"59a85bd52bdf3600193d4fd5","results":{"codes":[]},"examples":{"codes":[]},"method":"post","auth":"required","params":[{"_id":"59c7e213c50cf30010d71185","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"59c7e454791ca600105b9754","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"url"},{"_id":"59c7e454791ca600105b9753","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"secret"},{"_id":"59c7e454791ca600105b9752","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"description"},{"_id":"59c7e454791ca600105b9751","ref":"","in":"body","required":false,"desc":"","default":"","type":"boolean","name":"disabled"}],"url":"/:id"},"isReference":false,"order":3,"body":"# Details\n\nUpdate a webhook.\n\nAn account token or server token may be used to run this endpoint.\n\n# Parameters\n\n## path\n\n- id (required): The ID of the webhook.\n\n## body\n\n- url (optional): 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- disabled (optional): Whether a webhook is disabled. Default is false.\n\n# Responses\n\n## 200\n\n- No content returned, only the status code. See the REST API “Standard Responses” page.\n\n## 400\n\n- __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.\n- __Webhook Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the ID given for a webhook was not valid.\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- __Webhook Not Found:__ This error means that a webhook with the given ID was not found, although it existed at some point.\n\n# Examples\n\n## HTTP\n\n```\nPUT https://ioe.droplit.io/api/webhooks/WEBHOOK-ID HTTP/1.1\nauthorization: TOKEN\ncontent-type: application/json\n{\n    \"description\": \"Test hook\"\n}\n```\n\n## Droplit Console\n\n```\ndroplit webhook update WEBHOOK-ID PROPERTY-NAME PROPERTY-VALUE\n```","excerpt":"","slug":"webhooks-update","type":"endpoint","title":"Update a webhook."}

postUpdate a webhook.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string

Body Params

url:
string
secret:
string
description:
string
disabled:
boolean

Documentation

# Details Update a webhook. An account token or server token may be used to run this endpoint. # Parameters ## path - id (required): The ID of the webhook. ## body - url (optional): 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. - disabled (optional): Whether a webhook is disabled. Default is false. # Responses ## 200 - No content returned, only the status code. See the REST API “Standard Responses” page. ## 400 - __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint. - __Webhook Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the ID given for a webhook was not valid. - __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 - __Webhook Not Found:__ This error means that a webhook with the given ID was not found, although it existed at some point. # Examples ## HTTP ``` PUT https://ioe.droplit.io/api/webhooks/WEBHOOK-ID HTTP/1.1 authorization: TOKEN content-type: application/json { "description": "Test hook" } ``` ## Droplit Console ``` droplit webhook update WEBHOOK-ID PROPERTY-NAME PROPERTY-VALUE ```

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