List all webhooks

get
https://api.box.com/2.0
/webhooks

Returns all defined webhooks for the requesting application.

Request

application/json

Query Parameters

integer / int64in queryoptional
10001000-1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

The position marker at which to begin the response.

This requires usemarker to be set to true.

Response

application/jsonWebhooks

Returns a list of webhooks.

application/jsonClient Error

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

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

Request Example

cURL
curl -X GET https://api.box.com/2.0/webhooks \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxCollectionMarkerBased<BoxWebhook> webhooks = await client.WebhooksManager.GetWebhooksAsync();
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('The webhook ID is {0} and the address is {1}'.format(webhook.id, webhook.address))
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 }
		*/
	});

Response Example

{
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000,
  "entries": [
    {
      "id": 11446498,
      "type": "webhook",
      "target": {
        "id": 1231232,
        "type": "file"
      },
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "address": "https://example.com/webhooks",
      "triggers": [
        "FILE.UPLOADED"
      ]
    }
  ]
}