Box Developer Documentation
 

    Webhook (Mini)

    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 mini variant are generally returned when the resource is nested within the response for another resource.

    string
    11446498

    The unique identifier for this webhook.

    string
    webhook

    webhook

    Value is always webhook

    object

    The item that will trigger the webhook

    string
    1231232

    The ID of the item to trigger a webhook

    file

    The type of item to trigger a webhook

    Value is one of file,folder

    Response Example

    {
      "id": "11446498",
      "type": "webhook",
      "target": {
        "id": "1231232",
        "type": "file"
      }
    }