Webhooks

Webhooks

Webhooks allow you to monitor Box content for events and receive notifications to a URL of your choice when they occur. For example, a workflow may include waiting for a file to be downloaded to delete a shared link. A webhook can be set on the file and upon notification of the download event, a script can launch to make an API call to delete the shared link.

Versions

There are two types of webhooks: v1 and v2, which are compared below.

V1V2
Created in the Developer ConsoleCreated with an API call
Set at the root levelSet on specific files/folders, but cannot set at the root
Select from 14 event triggersSelect from 30+ event triggers
Provides selected callback parametersPayload includes full object response & additional context info
No retry mechanism after notification delivery failureRetries up to 10 times after notification delivery failure
Does not support payload verificationSupports payload verification
Notification URL can be HTTP or HTTPSNotification URL must be HTTPS
Does not scale wellScales well and has increased reliability