Box Developer Documentation
Log in

Webhook

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

Represents a configured webhook.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
11446498

The unique identifier for this webhook.

string
webhook

webhook

Value is always webhook

string
https://example.com/webhooks

The URL that is notified by this webhook

string (date-time)
2012-12-12T10:53:43-08:00

A timestamp identifying the time that the webhook was created.

User (Mini) object

The user who created the webhook

object

The item that will trigger the webhook

string
1231232

The ID of the item to trigger a webhook

string
file

The type of item to trigger a webhook

Value is one of file,folder

string array
["FILE.UPLOADED"]

An array of event names that this webhook is to be triggered for

Response Example

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