Skip to main content
API version 2024.0 Represents a configured webhook.
This resource has a few variations that can be encountered when using the API.The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.
​
id
string
example: 11446498The unique identifier for this webhook.
​
type
string
example: webhookThe value will always be webhook.Value is always webhook
​
address
string
example: https://example.com/webhooksThe URL that is notified by this webhook.
​
created_at
string(date-time)
example: 2012-12-12T10:53:43-08:00A timestamp identifying the time that the webhook was created.
​
created_by
User (Mini)object
The user who created the webhook.
​
target
object
The item that will trigger the webhook.
​
triggers
stringarray
example: ["FILE.UPLOADED"]An array of event names that this webhook is to be triggered for.
{
  "id": "11446498",
  "type": "webhook",
  "address": "https://example.com/webhooks",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "target": {
    "id": "1231232",
    "type": "file"
  },
  "triggers": [
    "FILE.UPLOADED"
  ]
}