Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Webhooks

Create webhook

Creates a webhook.

post/webhooks

Request body

addressstring required

The URL that is notified by this webhook.

triggersstring[] required

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

Example request

{
  "target": {
    "id": "1231232",
    "type": "file"
  },
  "address": "https://example.com/webhooks",
  "triggers": [
    "FILE.UPLOADED"
  ]
}

Response

Returns the new webhook object.

idstring

The unique identifier for this webhook.

type'webhook'

The value will always be webhook.

created_atstring date-time

A timestamp identifying the time that the webhook was created.

addressstring

The URL that is notified by this webhook.

triggersstring[]

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

Example response

{
  "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"
  ]
}