Box · Schema
Webhook
Represents a configured webhook.
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
JSON Schema
{
"$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"
]
}
}
}
}
]
}