Webhook

Represents a configured webhook.

address string

examplehttps://example.com/webhooks

The URL that is notified by this webhook

created_at string / date-time

example2012-12-12T10:53:43-08:00

A timestamp identifying the time that the webhook was created.

created_byUser (Mini) object

The user who created the webhook

id string

example11446498

The unique identifier for this object

target object

The item that will trigger the webhook

target.id string

example1231232

The ID of the item to trigger a webhook

target.type string

examplefile

The type of item to trigger a webhook

Value is one of file,folder

triggersstring array

example["FILE.UPLOADED"]

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

type string

examplewebhook

Value is always webhook

Response Example

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