メインコンテンツへスキップ
POST
/
webhooks
cURL
curl -i -X POST "https://api.box.com/2.0/webhooks" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "target": {
         "id": "21322",
         "type": "file"
       },
       "address": "https://example.com/webhooks",
       "triggers": [
         "FILE.PREVIEWED"
       ]
     }'
{
  "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"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

​
Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

ボディ

application/json
​
target
object
必須

Webhookをトリガーする項目。

​
address
string
必須

このWebhookによって通知されるURL。

例:

"https://example.com/webhooks"

​
triggers
enum<string>[]
必須

このWebhookがトリガーされるイベント名の配列。

このWebhookをトリガーしたイベント名。

利用可能なオプション:
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,
SIGN_REQUEST.COMPLETED,
SIGN_REQUEST.DECLINED,
SIGN_REQUEST.EXPIRED,
SIGN_REQUEST.SIGNER_EMAIL_BOUNCED,
SIGN_REQUEST.SIGN_SIGNER_SIGNED,
SIGN_REQUEST.SIGN_DOCUMENT_CREATED,
SIGN_REQUEST.SIGN_ERROR_FINALIZING
例:
["FILE.UPLOADED"]

レスポンス

新しいWebhookオブジェクトを返します。

設定されたWebhookを表します。

​
id
string

このWebhookの一意の識別子。

例:

"11446498"

​
type
enum<string>

値は常にwebhookになります。

利用可能なオプション:
webhook
例:

"webhook"

​
target
object

Webhookをトリガーする項目。

​
created_by
ユーザー (Mini) · object

Webhookを作成したユーザー。

​
created_at
string<date-time>

Webhookが作成された日時を示すタイムスタンプ。

例:

"2012-12-12T10:53:43-08:00"

​
address
string

このWebhookによって通知されるURL。

例:

"https://example.com/webhooks"

​
triggers
enum<string>[]

このWebhookがトリガーされるイベント名の配列。

このWebhookをトリガーしたイベント名。

利用可能なオプション:
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,
SIGN_REQUEST.COMPLETED,
SIGN_REQUEST.DECLINED,
SIGN_REQUEST.EXPIRED,
SIGN_REQUEST.SIGNER_EMAIL_BOUNCED,
SIGN_REQUEST.SIGN_SIGNER_SIGNED,
SIGN_REQUEST.SIGN_DOCUMENT_CREATED,
SIGN_REQUEST.SIGN_ERROR_FINALIZING
例:
["FILE.UPLOADED"]