Box Developer Documentation
Log in

Webhook invocation

The event that is sent to a webhook address when an event happens.

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

A timestamp identifying the time that the webhook event was triggered.

User (Mini) object

The user that triggered this event

string
11446498

The unique identifier for this object

File (Standard) / Folder (Standard) object

The item that caused the event to trigger

string
FILE.UPLOADED

The event name that triggered this webhook

Value is one of 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

string
webhook_event

Value is always webhook_event

Webhook object

The webhook object that triggered this event

Response Example

{
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "id": 11446498,
  "source": {
    "content_created_at": "2012-12-12T10:53:43-08:00",
    "content_modified_at": "2012-12-12T10:53:43-08:00",
    "created_at": "2012-12-12T10:53:43-08:00",
    "created_by": {
      "id": 11446498,
      "login": "ceo@example.com",
      "name": "Aaron Levie",
      "type": "user"
    },
    "description": "Contract for Q1 renewal",
    "etag": 1,
    "file_version": {
      "id": 12345,
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
      "type": "file_version"
    },
    "id": 12345,
    "item_status": "active",
    "modified_at": "2012-12-12T10:53:43-08:00",
    "modified_by": {
      "id": 11446498,
      "login": "ceo@example.com",
      "name": "Aaron Levie",
      "type": "user"
    },
    "name": "Contract.pdf",
    "owned_by": {
      "id": 11446498,
      "login": "ceo@example.com",
      "name": "Aaron Levie",
      "type": "user"
    },
    "parent": {
      "etag": 1,
      "id": 12345,
      "name": "Contracts",
      "sequence_id": 3,
      "type": "folder"
    },
    "path_collection": {
      "entries": [
        {
          "id": 12345,
          "etag": 1,
          "type": "folder",
          "sequence_id": 3,
          "name": "Contracts"
        }
      ],
      "total_count": 1
    },
    "purged_at": "2012-12-12T10:53:43-08:00",
    "sequence_id": 3,
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "shared_link": {
      "access": "open",
      "download_count": 3,
      "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
      "effective_access": "company",
      "effective_permission": "can_download",
      "is_password_enabled": true,
      "permissions": {
        "can_download": true,
        "can_preview": true
      },
      "preview_count": 3,
      "unshared_at": "2018-04-13T13:53:23-07:00",
      "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
      "vanity_url": "https://acme.app.box.com/v/my_url/"
    },
    "size": 629644,
    "trashed_at": "2012-12-12T10:53:43-08:00",
    "type": "file"
  },
  "trigger": "FILE.UPLOADED",
  "type": "webhook_event",
  "webhook": {
    "address": "https://example.com/webhooks",
    "created_at": "2012-12-12T10:53:43-08:00",
    "created_by": {
      "id": 11446498,
      "login": "ceo@example.com",
      "name": "Aaron Levie",
      "type": "user"
    },
    "id": 11446498,
    "target": {
      "id": 1231232,
      "type": "file"
    },
    "triggers": [
      "FILE.UPLOADED"
    ],
    "type": "webhook"
  }
}