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

Droplit SDK

droplit.webhooks.updateWebhook("WEBHOOK-ID", { "PROPERTY-NAME" : "PROPERTY-VALUE", ... });