Box · Schema

Webhook

Represents a configured webhook.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile SharingBoxStorage

Properties

Name Type Description
created_by object
created_at string A timestamp identifying the time that the webhook was created.
address string The URL that is notified by this webhook
triggers array An array of event names that this webhook is to be triggered for
View JSON Schema on GitHub

JSON Schema

box-webhook-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Webhook",
  "title": "Webhook",
  "type": "object",
  "x-box-resource-id": "webhook",
  "x-box-variant": "standard",
  "x-box-tag": "webhooks",
  "description": "Represents a configured webhook.",
  "allOf": [
    {
      "$ref": "#/components/schemas/Webhook--Mini"
    },
    {
      "properties": {
        "created_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who created the webhook"
            }
          ]
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "A timestamp identifying the time that\nthe webhook was created.",
          "example": "2012-12-12T10:53:43-08:00"
        },
        "address": {
          "type": "string",
          "example": "https://example.com/webhooks",
          "description": "The URL that is notified by this webhook"
        },
        "triggers": {
          "type": "array",
          "example": [
            "FILE.UPLOADED"
          ],
          "description": "An array of event names that this webhook is\nto be triggered for",
          "items": {
            "title": "Webhook Trigger",
            "example": "FILE.UPLOADED",
            "type": "string",
            "description": "The event name that triggered this webhook",
            "enum": [
              "FILE.UPLOADED",
              "FILE.PREVIEWED",
              "FILE.DOWNLOADED",
              "FILE.TRASHED",
              "FILE.DELETED",
              "FILE.RESTORED",
              "FILE.COPIED",
              "FILE.MOVED",
              "FILE.LOCKED",
              "FILE.UNLOCKED",
              "FILE.RENAMED",
              "COMMENT.CREATED",
              "COMMENT.UPDATED",
              "COMMENT.DELETED",
              "TASK_ASSIGNMENT.CREATED",
              "TASK_ASSIGNMENT.UPDATED",
              "METADATA_INSTANCE.CREATED",
              "METADATA_INSTANCE.UPDATED",
              "METADATA_INSTANCE.DELETED",
              "FOLDER.CREATED",
              "FOLDER.RENAMED",
              "FOLDER.DOWNLOADED",
              "FOLDER.RESTORED",
              "FOLDER.DELETED",
              "FOLDER.COPIED",
              "FOLDER.MOVED",
              "FOLDER.TRASHED",
              "WEBHOOK.DELETED",
              "COLLABORATION.CREATED",
              "COLLABORATION.ACCEPTED",
              "COLLABORATION.REJECTED",
              "COLLABORATION.REMOVED",
              "COLLABORATION.UPDATED",
              "SHARED_LINK.DELETED",
              "SHARED_LINK.CREATED",
              "SHARED_LINK.UPDATED",
              "SIGN_REQUEST.COMPLETED",
              "SIGN_REQUEST.DECLINED",
              "SIGN_REQUEST.EXPIRED",
              "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED"
            ]
          }
        }
      }
    }
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/box-webhook"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.