Webhooks
Create webhook
Creates a webhook.
POST
cURL
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.
Authorizations
Body
application/json
An array of event names that this webhook is to be triggered for.
The event name that triggered this webhook.
Available options:
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, SIGN_REQUEST.SIGN_SIGNER_SIGNED, SIGN_REQUEST.SIGN_DOCUMENT_CREATED, SIGN_REQUEST.SIGN_ERROR_FINALIZING Example:
Response
Returns the new webhook object.
Represents a configured webhook.
An array of event names that this webhook is to be triggered for.
The event name that triggered this webhook.
Available options:
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, SIGN_REQUEST.SIGN_SIGNER_SIGNED, SIGN_REQUEST.SIGN_DOCUMENT_CREATED, SIGN_REQUEST.SIGN_ERROR_FINALIZING Example:
Last modified on January 23, 2026
