Update Webhooks
Update Webhooks
You can update a webhook using the Developer Console or API.
Developer Console
To update a webhook in the Developer Console, follow the steps below.
- Go to the Webhooks tab in the Developer Console to display all webhooks.
- Select the webhook you want to update by clicking on its ID.
- Click the Edit webhook button.
- Fill in the data you want to update.
- Click the Update button to save your changes.
API
To update a webhook, use the update webhook endpoint, which requires the webhook ID. To find the ID of the webhook, use the list all webhooks endpoint.
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)\"")
}