Box · Schema

Webhook (Mini)

Represents a configured webhook.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
id	string	The unique identifier for this webhook.
type	string	`webhook`
target	object	The item that will trigger the webhook

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Webhook--Mini",
  "title": "Webhook (Mini)",
  "type": "object",
  "x-box-resource-id": "webhook--mini",
  "x-box-tag": "webhooks",
  "x-box-variants": [
    "mini",
    "standard"
  ],
  "x-box-variant": "mini",
  "description": "Represents a configured webhook.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this webhook.",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`webhook`",
      "example": "webhook",
      "enum": [
        "webhook"
      ]
    },
    "target": {
      "type": "object",
      "description": "The item that will trigger the webhook",
      "properties": {
        "id": {
          "description": "The ID of the item to trigger a webhook",
          "type": "string",
          "example": "1231232"
        },
        "type": {
          "description": "The type of item to trigger a webhook",
          "type": "string",
          "example": "file",
          "enum": [
            "file",
            "folder"
          ]
        }
      }
    }
  }
}