Box Developer Documentation
Log in

Limitations

Guides Webhooks V2 Webhooks Limitations
Edit this page

Limitations

One webhook per item

There's a limit of one webhook for each item (file or folder), each application and each authenticated user.

Once a webhook is attached to an item, no second webhook can be attached, even if the second webhook would respond to a different trigger event.

Example: a webhook is set up by John Doe to watch FILE.UPLOADED events in a folder with the name Junk, for an application named CleanupApp. At that point, no second webhook can be added to the Junk folder by the CleanupApp by John Doe, even if it is to trigger for an FILE.DOWNLOADED event.

To listen to another event, update the existing webhook or create a new application.

1000 webhooks limit

There is a limit of 1000 webhooks for each application and each user.

To create more webhooks for a user, create another application or update existing webhooks to apply to higher levels in the folder tree.

Notification URL restrictions

The notification URL or address for a webhook must be a valid HTTPS URL that resolves to a valid IP address. It needs to have a certificate signed by a reputable certificate authority. Box does not support self-signed SSL certificates.

The IP address of the server must be publicly accessible from the internet and cannot be a (*.)box.com address. The port used in the URL must be the standard HTTPS port (443). Notifications will not be delivered to other ports.

The supported TLS protocol versions are TLS 1.2 and TLS 1.3 with FIPS-compliant cipher suites.

No webhooks on root folder

V2 webhooks cannot be created on the root folder, which is the folder with ID 0. Instead, you will need to use a v1 webhook.

When the permissions on an item prevent an action from occurring, no notification is sent for the attempted action.

NO_ACTIVE_SESSION is set in the webhook payload

If the auth session (access token) for the app you used to create a webhook expires, that webhook no longer sends events with a full payload. In that case, the event trigger is NO_ACTIVE_SESSION.

JWT Auth

For webhooks created with the JWT Auth app, the session expires when you delete the app authorization for this app in the Admin Console. For more information, see application authorization guide.

OAuth 2.0

For webhooks created with OAuth 2.0 Auth app, the session expires when both the access token and the refresh token for the user and app used for creating that webhook expire.

Developer token

As the developer token cannot be refreshed and expires after 1 hour, the event trigger NO_ACTIVE_SESSION is set in the webhook payload after 1 hour.

Reasons for webhook deletion

The following reasons can cause webhooks to be deleted.

  1. Deleting a Box application automatically deletes all webhooks associated with it.
  2. Deleting all active Access Tokens associated with a webhook automatically deletes the webhook. This includes Developer Tokens and password.
  3. A webhook is automatically deleted if the last successful delivery was 30 days ago and the period between the last successful delivery and the last trigger date is more than 14 days.

In all of these cases Box sends a webhook payload with the WEBHOOK.DELETED event name to the notification URL. The body of the payload includes the following additional information.

"additional_info": {
  "reason": "auto_cleanup"
}