Box Developer Documentation

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

Register now!

Webhook Event Triggers

Guides Webhooks Webhook Event Triggers
Edit this page

Webhook Event Triggers

V2

Files and Folders

The following is a list of events that can be configured to trigger a V2 webhook. Some events are only available for files, while others are only available for folders.

EventTriggeredFile?Folder?
COLLABORATION.CREATEDA collaboration is created.NoYes
COLLABORATION.ACCEPTEDA collaboration is accepted.NoYes
COLLABORATION.REJECTEDA collaboration is rejected.NoYes
COLLABORATION.REMOVEDA collaboration is removed.NoYes
COLLABORATION.UPDATEDA collaboration is updated.NoYes
COMMENT.CREATEDA comment object is created.YesYes
COMMENT.UPDATEDA comment object is edited.YesYes
COMMENT.DELETEDA comment object is removed.YesYes
FILE.UPLOADEDA file is uploaded or moved to this folder.NoYes
FILE.PREVIEWEDA file is previewed.YesYes
FILE.DOWNLOADEDA file is downloaded.YesYes
FILE.TRASHEDA file is moved to trash.YesYes
FILE.DELETEDA file is permanently deleted.YesYes
FILE.RESTOREDA file is restored from trash.YesYes
FILE.COPIEDA file is copied.YesYes
FILE.MOVEDA file is moved from one folder to another.YesYes
FILE.LOCKEDA file is locked.YesYes
FILE.UNLOCKEDA file is unlocked.YesYes
FILE.RENAMEDA file is renamed.YesYes
FOLDER.CREATEDA folder is createdNoYes
FOLDER.RENAMEDA folder is renamed.NoYes
FOLDER.DOWNLOADEDA folder is downloaded.NoYes
FOLDER.RESTOREDA folder is restored from trash.NoYes
FOLDER.DELETEDA folder is permanently removed.NoYes
FOLDER.COPIEDA folder is copied.NoYes
FOLDER.MOVEDA folder is moved to a different folder.NoYes
FOLDER.TRASHEDA folder is moved to trash.NoYes
METADATA_INSTANCE.CREATEDA new metadata template instance is associated with a file or folder.YesYes
METADATA_INSTANCE.UPDATEDAn attribute (value) is updated/deleted for an existing metadata template instance associated with a file or folder.YesYes
METADATA_INSTANCE.DELETEDAn existing metadata template instance associated with a file or folder is deleted.YesYes
SHARED_LINK.DELETEDA shared link is deleted.YesYes
SHARED_LINK.CREATEDA shared link is created.YesYes
SHARED_LINK.UPDATEDA shared link is updated.YesYes
TASK_ASSIGNMENT.CREATEDA task is created.YesYes
TASK_ASSIGNMENT.UPDATEDA task assignment is changed.YesYes
SIGN_REQUEST.COMPLETEDA sign request is completed.YesYes
SIGN_REQUEST.DECLINEDA sign request is declined.YesYes
SIGN_REQUEST.EXPIREDA sign request is expired.YesYes
SIGN_REQUEST.SIGNER_EMAIL_BOUNCEDA signer's email is bounced.YesYes
WEBHOOK.DELETEDA webhook is deleted.NoNo

V1

Events that can be configured to trigger a v1 webhook:

  • Sent,
  • Created,
  • Uploaded,
  • Commented,
  • Downloaded,
  • Previewed,
  • Moved,
  • Copied,
  • Task assigned,
  • Responded to task,
  • Locked,
  • Unlocked,
  • Deleted,
  • Collaborator added.