Box Developer Documentation

List Webhooks for a User

List Webhooks for a User

To fetch all webhooks for the authenticated user, use the list all webhooks endpoint.

cURL
curl -i -X GET "https://api.box.com/2.0/webhooks" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.webhooks.getWebhooks();
Python Gen
client.webhooks.get_webhooks()
.NET Gen
await client.Webhooks.GetWebhooksAsync();
Swift Gen (Beta)
try await client.webhooks.getWebhooks()
Java
Iterable<BoxWebHook.Info> webhooks = BoxWebHook.all(api);
for (BoxWebHook.Info webhookInfo: webhooks) {
    // Do something with the webhook.
}
Python
webhooks = client.get_webhooks()
for webhook in webhooks:
    print(f'The webhook ID is {webhook.id} and the address is {webhook.address}')
.NET
BoxCollectionMarkerBased<BoxWebhook> webhooks = await client.WebhooksManager.GetWebhooksAsync();
Node
client.webhooks.getAll()
	.then(webhooks => {
		/* webhooks -> {
			next_marker: 'ZmlQZS0xLTE%3D',
			entries: 
			[ { id: '1234',
				type: 'webhook',
				target: { id: '22222', type: 'folder' } },
				{ id: '5678',
				type: 'webhook',
				target: { id: '11111', type: 'file' } } ],
			limit: 2 }
		*/
	});
iOS
let iterator = client.webhooks.list()
iterator.next { results in
    switch results {
    case let .success(page):
        for webhook in page.entries {
            print("Webhook \(webhook.id) was created at \(webhook.createdAt)")
        }

    case let .failure(error):
        print(error)
    }
}

This endpoint requires the application to have the Manage Webhooks scope enabled.

This API call will only list the webhooks for the authenticated user, not for any other users in the enterprise.