Box Developer Documentation
Log in

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

Create Webhooks

Guides Webhooks V1 Webhooks Create Webhooks
Edit this page

Required Guides

Create Webhooks

V1 webhooks are created in the Developer Console by following the steps below.

  1. Navigate to your application in the Developer Console
  2. Select the Webhooks tab.
  3. Click the Create a new Webhook button.
  4. Fill in the form, including event triggers, an endpoint URL and one or more callback parameters.
  5. Click Save Webhook.

Callback parameters

Unlike the V2 Webhooks, these manual webhooks need to be configured with the data you'd like. This data will be sent as a query string either in the body or as a query parameter, for example name=Contract.pdf&type=file.

Developer Mode

By default V1 webhooks only work for users that are listed as application collaborators in the General Settings tab in the Developer Console. To enable a webhooks for all users, please contact support.

Enabling a webhook

After creating a webhook, the application must be added to the user's account to begin use.

To obtain the URL to add the app, follow the directions below for OAuth 2.0 authentication apps:

  1. Navigate to the App Center tab for the application in the Developer Console.
  2. Click Submit My App. Do not worry, you will not be completing the submission process!
  3. At the bottom of the page, click Preview.
  4. Click Add

For all other authentication types, you will need to contact support to obtain this URL.

Webhooks will now trigger for any configured events that are occur in the user's account.