Box Developer Documentation
Log in

Update webhook

put
https://api.box.com/2.0
/webhooks/:webhook_id

Updates a webhook.

Related Guides

Request

application/json

Path Parameters

stringin pathrequired
3321123

The ID of the webhook.

Request Body

stringin bodyoptional
https://example.com/webhooks

The URL that is notified by this webhook

objectin body

The item that will trigger the webhook

stringnulloptional
1231232

The ID of the item to trigger a webhook

stringnulloptional
file

The type of item to trigger a webhook

Value is one of file,folder

string arrayin bodyoptional
["FILE.UPLOADED"]

An array of event names that this webhook is to be triggered for

Response

application/jsonWebhook

Returns the new webhook object.

application/jsonClient error

Returns an error if the parameters were incorrect.

application/jsonClient error

Returns an error if the application does not have the permission to manage webhooks.

application/jsonClient error

Returns an error if the target item or webhook could not be found

application/jsonClient error

Returns an error if the a webhook for this combination of target, application, and user already exists.

application/jsonClient error

An unexpected client error.

put
Update webhook
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -X PUT https://api.box.com/2.0/webhooks/3321123 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
     -H 'Content-Type: application/json" '
     -d '{
       "triggers": [
         "FILE.DOWNLOADED"
       ]
     }'
.NET
var updates = new BoxWebhookRequest()
{
    Id = "12345",
    Address = "https://example.com/webhooks/fileActions
};
BoxWebhook updatedWebhook = await client.WebhooksManager.UpdateWebhookAsync(updates);
Java
BoxWebHook webhook = new BoxWebHook(api, id);
BoxWebHook.Info info = webhook.getInfo();
info.addPendingChange("address", url);
webhook.update(info);
Python
update_object = {
    'triggers': ['FILE.COPIED'],
    'address': 'https://newexample.com',
}
webhook = client.webhook(webhook_id='12345').update_info(update_object)
print('Updated the webhook info for triggers: {0} and address: {1}'.format(webhook.triggers, webhook.address))
Node
client.webhooks.update('678901', {address: "https://example.com/webhooks/fileActions"})
	.then(webhook => {
		/* webhook -> {
			id: '1234',
			type: 'webhook',
			target: { id: '22222', type: 'folder' },
			created_by: 
			{ type: 'user',
				id: '33333',
				name: 'Example User',
				login: 'user@example.com' },
			created_at: '2016-05-09T17:41:27-07:00',
			address: 'https://example.com/webhooks/fileActions',
			triggers: [ 'FILE.DOWNLOADED', 'FILE.UPLOADED' ] }
		*/
	});
iOS
client.webhooks.update(webhookId: "1234", targetType: "file", targetId: "1234", address: "www.testurl.com") { (result: Result<Webhook, BoxSDKError>) in
    guard case let .success(webhook) = result else {
        print("Error updating webhook")
        return
    }

    print("Updated webhook address to \"\(webhook.address)\"")
}