Box · Schema

Webhook (V2) payload

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

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for this webhook invocation
type string `webhook_event`
webhook object
created_by object
created_at string A timestamp identifying the time that the webhook event was triggered.
trigger object
source object
View JSON Schema on GitHub

JSON Schema

box-webhookinvocation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebhookInvocation",
  "title": "Webhook (V2) payload",
  "type": "object",
  "x-box-resource-id": "webhook_invocation",
  "x-box-tag": "webhooks",
  "description": "The event that is sent to a webhook address when an event happens.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this webhook invocation",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`webhook_event`",
      "example": "webhook_event",
      "enum": [
        "webhook_event"
      ]
    },
    "webhook": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Webhook"
        },
        {
          "description": "The webhook object that triggered this event"
        }
      ]
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user that triggered this event"
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "A timestamp identifying the time that\nthe webhook event was triggered.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "trigger": {
      "allOf": [
        {
          "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"
          ]
        },
        {
          "description": "The event name that triggered this webhook"
        }
      ]
    },
    "source": {
      "allOf": [
        {
          "oneOf": [
            {
              "$ref": "#/components/schemas/File"
            },
            {
              "$ref": "#/components/schemas/Folder"
            }
          ]
        },
        {
          "description": "The item that caused the event to trigger"
        }
      ]
    }
  }
}