Manage Applications

    Webhook

    Represents a configured webhook.

    string
    https://example.com/webhooks

    The URL that is notified by this webhook

    string / date-time
    2012-12-12T10:53:43-08:00

    A timestamp identifying the time that the webhook was created.

    The user who created the webhook

    string
    11446498

    The unique identifier for this object

    object

    The item that will trigger the webhook

    string
    1231232

    The ID of the item to trigger a webhook

    string
    file

    The type of item to trigger a webhook

    Value is one of "file", "folder"

    string array
    ["FILE.UPLOADED"]

    An array of event names that this webhook is to be triggered for

    Value is any of "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"

    string
    webhook

    Value is always "webhook"

    Response Example

    {
      "id": 11446498,
      "type": "webhook",
      "target": {
        "id": 1231232,
        "type": "file"
      },
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "address": "https://example.com/webhooks",
      "triggers": [
        "FILE.UPLOADED"
      ]
    }