Get webhook

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

Retrieves a specific webhook

Request

application/json

Path Parameters

stringin pathrequired
3321123

The ID of the webhook.

Response

application/jsonWebhook

Returns a webhook object

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 webhook could not be found

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/3321123 \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxWebhook webhook = await client.WebhooksManager.GetWebhookAsync("12345");
Java
BoxWebHook webhook = new BoxWebHook(api, id);
BoxWebHook.Info info = webhook.getInfo();
Python
webhook = client.webhook(webhook_id='12345').get()
print('Webhooks ID is {0} and the address is {1}'.format(webhook.id, webhook.address))
Node
client.webhooks.get('1234')
	.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/webhook',
			triggers: [ 'FILE.DOWNLOADED', 'FILE.UPLOADED' ] }
		*/
	});

Response Example

{
  "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"
  ]
}