Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

Represents a configured webhook.

​
id
string

The unique identifier for this webhook.

Example:

"11446498"

​
type
enum<string>

The value will always be webhook.

Available options:
webhook
Example:

"webhook"

​
target
object

The item that will trigger the webhook.

​
created_by
User (Mini) · object

The user who created the webhook.

​
created_at
string<date-time>

A timestamp identifying the time that the webhook was created.

Example:

"2012-12-12T10:53:43-08:00"

​
address
string

The URL that is notified by this webhook.

Example:

"https://example.com/webhooks"

​
triggers
enum<string>[]

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:
["FILE.UPLOADED"]