Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Update webhook
Updates a webhook.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
3321123The 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
stringin bodyoptional
"1231232"The ID of the item to trigger a webhook
stringin bodyoptional
"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.
Request Example
cURL
curl -i -X PUT "https://api.box.com/2.0/webhooks/3321123" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"triggers": [
"FILE.DOWNLOADED"
]
}'TypeScript Gen
await client.webhooks.updateWebhookById(webhook.id!, {
requestBody: {
address: 'https://example.com/updated-webhook',
} satisfies UpdateWebhookByIdRequestBody,
} satisfies UpdateWebhookByIdOptionalsInput);Python Gen
client.webhooks.update_webhook_by_id(
webhook.id, address="https://example.com/updated-webhook"
).NET Gen
await client.Webhooks.UpdateWebhookByIdAsync(webhookId: NullableUtils.Unwrap(webhook.Id), requestBody: new UpdateWebhookByIdRequestBody() { Address = "https://example.com/updated-webhook" });Swift Gen (Beta)
try await client.webhooks.updateWebhookById(webhookId: webhook.id!, requestBody: UpdateWebhookByIdRequestBody(address: "https://example.com/updated-webhook"))Java
BoxWebHook webhook = new BoxWebHook(api, id);
BoxWebHook.Info info = webhook.new Info();
info.setAddress(url);
webhook.update(info);Python
update_object = {
'triggers': ['FILE.COPIED'],
'address': 'https://newexample.com',
}
webhook = client.webhook(webhook_id='12345').update_info(data=update_object)
print(f'Updated the webhook info for triggers: {webhook.triggers} and address: {webhook.address}').NET
var updates = new BoxWebhookRequest()
{
Id = "12345",
Address = "https://example.com/webhooks/fileActions
};
BoxWebhook updatedWebhook = await client.WebhooksManager.UpdateWebhookAsync(updates);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)\"")
}Response Example
{
"id": "11446498",
"type": "webhook",
"address": "https://example.com/webhooks",
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"target": {
"id": "1231232",
"type": "file"
},
"triggers": [
"FILE.UPLOADED"
]
}