Join BoxWorks 2024 to discover what's possible with content and AI!

Webhook

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

example11446498

The unique identifier for this webhook.

type string

examplewebhook

webhook

Value is always 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

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

triggers string array

example["FILE.UPLOADED"]

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

Response Example

{
  "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": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "target": {
    "id": "1231232",
    "type": "file"
  },
  "triggers": [
    "FILE.UPLOADED"
  ]
}