Box Developerドキュメント
ログイン

スキルのWebhookペイロード

スキルのinvocation_urlに送信されるBoxスキルのペイロード。

string
fd1d2e53-35f5-41fb-9c25-4ba326daf2f9_341016304

呼び出しリクエストの一意の識別子。

string
skill_invocation

skill_invocation

次の値に固定: skill_invocation

string (date-time)
2012-12-12T10:53:43-08:00

この呼び出しが作成された日時。

object

この呼び出しをトリガーする対象になった会社

string
11446498

この会社の一意の識別子。

string
enterprise

enterprise

次の値に固定: enterprise

string
Acme Inc.

会社の名前

Event object

この呼び出しをトリガーしたイベント

object

この呼び出しをトリガーしたスキル

string
11446498

このスキルの一意の識別子

string
skill

skill

次の値に固定: skill

string
hxel2s12wd2h9r8ne103c4gjbqefofih

アプリケーションのクライアントID

string
Hello World Skill

スキルの名前

File / Folder object

呼び出しがトリガーされる原因となった項目

object

このイベントの詳細のステータス。

string
Example

追加のステータス情報。

string
400

エラーコード情報 (エラーが発生した場合)。

string
Example

ステータス情報

string
invoked

このイベントの状態。

  • invoked - ファイルへのスキルの適用を開始するためにイベント詳細を使用してスキルをトリガーしました。
  • processing - 現在処理中です。
  • success - 処理が正常に完了しました。
  • transient_failure - 再試行可能な問題が発生しました。
  • permanent_failure - 再試行しても解決できない永続的な問題が発生しました。

次の値のいずれか1つ: invoked,processing,success,transient_failure,permanent_failure

object

この項目の読み取り専用および読み取り/書き込みアクセス権限トークン

object

アクセストークンの基本情報

string (token)
c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ

リクエストされたアクセストークン。

integer (int64)
3600

このトークンが期限切れになるまでの秒数。

string
[{"scope":"gcm"}, {"scope":"item_upload","object_id":933941692081,"object_type":"file"}, {"scope":"manage_skill_invocations"}]

このアクセストークンで許可される権限を返します。これにより、リソース (ファイルやフォルダなど) のリストと、各リソースで許可されるスコープが提供されます。

string
bearer

返されるアクセストークンのタイプ。

次の値に固定: bearer

object

アクセストークンの基本情報

string (token)
c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ

リクエストされたアクセストークン。

integer (int64)
3600

このトークンが期限切れになるまでの秒数。

string
[{"scope":"gcm"}, {"scope":"item_upload","object_id":933941692081,"object_type":"file"}, {"scope":"manage_skill_invocations"}]

このアクセストークンで許可される権限を返します。これにより、リソース (ファイルやフォルダなど) のリストと、各リソースで許可されるスコープが提供されます。

string
bearer

返されるアクセストークンのタイプ。

次の値に固定: bearer

string
FILE_CONTENT

呼び出しをトリガーしたアクション

レスポンスの例

{
  "id": "fd1d2e53-35f5-41fb-9c25-4ba326daf2f9_341016304",
  "type": "skill_invocation",
  "created_at": "2012-12-12T10:53:43-08:00",
  "enterprise": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "event": {
    "type": "event",
    "additional_details": {
      "key": "value"
    },
    "created_at": "2022-12-12T10:53:43-08:00",
    "created_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "event_id": "f82c3ba03e41f7e8a7608363cc6c0390183c3f83",
    "event_type": "FILE_MARKED_MALICIOUS",
    "recorded_at": "2022-12-12T10:54:43-08:00",
    "session_id": "70090280850c8d2a1933c1",
    "source": {
      "id": "11446498",
      "type": "user",
      "address": "900 Jefferson Ave, Redwood City, CA 94063",
      "avatar_url": "https://www.box.com/api/avatar/large/181216415",
      "created_at": "2012-12-12T10:53:43-08:00",
      "job_title": "CEO",
      "language": "en",
      "login": "ceo@example.com",
      "max_upload_size": 2147483648,
      "modified_at": "2012-12-12T10:53:43-08:00",
      "name": "Aaron Levie",
      "notification_email": {
        "email": "notifications@example.com",
        "is_confirmed": true
      },
      "phone": "6509241374",
      "space_amount": 11345156112,
      "space_used": 1237009912,
      "status": "active",
      "timezone": "Africa/Bujumbura"
    }
  },
  "skill": {
    "id": "11446498",
    "type": "skill",
    "api_key": "hxel2s12wd2h9r8ne103c4gjbqefofih",
    "name": "Hello World Skill"
  },
  "source": {
    "id": "12345",
    "type": "file",
    "content_created_at": "2012-12-12T10:53:43-08:00",
    "content_modified_at": "2012-12-12T10:53:43-08:00",
    "created_at": "2012-12-12T10:53:43-08:00",
    "created_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "description": "Contract for Q1 renewal",
    "etag": "1",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "item_status": "active",
    "modified_at": "2012-12-12T10:53:43-08:00",
    "modified_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "name": "Contract.pdf",
    "owned_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "parent": {
      "id": "12345",
      "type": "folder",
      "etag": "1",
      "name": "Contracts",
      "sequence_id": "3"
    },
    "path_collection": {
      "entries": [
        {
          "etag": "1",
          "id": "12345",
          "type": "folder",
          "name": "Contracts",
          "sequence_id": "3"
        }
      ],
      "total_count": 1
    },
    "purged_at": "2012-12-12T10:53:43-08:00",
    "sequence_id": "3",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "shared_link": {
      "access": "open",
      "download_count": 3,
      "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
      "effective_access": "company",
      "effective_permission": "can_download",
      "is_password_enabled": true,
      "permissions": {
        "can_download": true,
        "can_edit": false,
        "can_preview": true
      },
      "preview_count": 3,
      "unshared_at": "2018-04-13T13:53:23-07:00",
      "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
      "vanity_name": "my_url",
      "vanity_url": "https://acme.app.box.com/v/my_url/"
    },
    "size": 629644,
    "trashed_at": "2012-12-12T10:53:43-08:00"
  },
  "status": {
    "additional_info": "Example",
    "error_code": "400",
    "message": "Example",
    "state": "invoked"
  },
  "token": {
    "read": {
      "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
      "expires_in": 3600,
      "restricted_to": "[{\"scope\":\"gcm\"}, {\"scope\":\"item_upload\",\"object_id\":933941692081,\"object_type\":\"file\"}, {\"scope\":\"manage_skill_invocations\"}]",
      "token_type": "bearer"
    },
    "write": {
      "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
      "expires_in": 3600,
      "restricted_to": "[{\"scope\":\"gcm\"}, {\"scope\":\"item_upload\",\"object_id\":933941692081,\"object_type\":\"file\"}, {\"scope\":\"manage_skill_invocations\"}]",
      "token_type": "bearer"
    }
  },
  "trigger": "FILE_CONTENT"
}