コラボレーションを作成する
Boxでフォルダのコラボレーションが作成された場合にフローをトリガーします。
コラボレーションの作成には、メールアドレス、ユーザーID、またはグループIDが使用されます。コラボレーションの作成にグループを使用した場合、このエンドポイントへのアクセスは、グループが招待される能力によって異なります。
オプション
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Folder ID(フォルダID) | フォルダーの一意のID。 | 文字列 | TRUE |
出力
フィールド | 定義 | タイプ |
---|---|---|
Event(イベント) | ||
Event ID(イベントID) | イベントの一意識別子。 | 文字列 |
Event Type(イベントタイプ) |
このファイルを作成したイベントのタイプ。
たとえば、Webhook Event。 |
文字列 |
Event Time(イベント時刻) | Boxでイベントがトリガーされた日時。 | Date and Time(日時) |
Webhook ID | このイベントをトリガーしたWebhookの一意識別子。 | 文字列 |
Event(イベント) | イベントをトリガーしたイベントの名前。 | 文字列 |
Collaboration(コラボレーション) | ||
Collaboration ID(コラボレーションID) | このコラボレーションの一意識別子。 | 文字列 |
Time Created(作成日時) | Boxでコラボレーションが作成された日時。 | Date and Time(日時) |
Time Modified(変更日時) | コラボレーションが最後に変更された日時。 | Date and Time(日時) |
Expires At(有効期限) | コラボレーションの有効期限。未設定の場合はnull。 | Date and Time(日時) |
Acknowledged At(承認日時) | コラボレーションオブジェクトのステータスがaccepted またはrejected に変更された日時。 |
文字列 |
Accessible By(アクセス可能) | ||
タイプ | アクセス権が付与されたユーザーまたはグループ。 | 文字列 |
ID | ユーザーまたはグループの一意識別子。 | 文字列 |
名前 | ユーザーまたはグループの表示名。 | 文字列 |
Login(ログイン) | ユーザーまたはグループのプライマリーメールアドレス。 | 文字列 |
Invite Email(招待メール) | 登録ユーザーでないコラボレーターの招待に使用されるメールアドレス。 | 文字列 |
Role(ロール) | 付与されるアクセス権のレベル。 | 文字列 |
Item Name(アイテム名) | アイテムの名前。 | 文字列 |
Item ID(アイテムID) | アイテムを表す一意識別子。 | 文字列 |
Item Type(アイテムタイプ) | アイテムのタイプ。 | 文字列 |
Item Status(アイテムステータス) | アイテムが削除済みであるかどうかを識別します。 | 文字列 |
Created By(作成者) | ||
名前 | コラボレーションを作成したユーザーの名前。 | 文字列 |
ユーザーID | ユーザーの一意識別子。 | 文字列 |
メール | ユーザーのメールアドレス。 | 文字列 |
Additional Info(追加情報) | ||
Additional Info(追加情報) | Boxから返される追加情報。 | オブジェクト |
コンテキスト | ||
Execution ID (実行ID) | Webhookイベントの実行識別子。 | 文字列 |
追加情報
以下の制限に注意してください。
-
Webhookは、認証済みユーザーのアプリケーションのアイテム(たとえば、ファイルまたはフォルダー)ごとに1つです。
-
Webhooksは、ユーザーのアプリケーションごとに1000です。
-
ルートフォルダーではWebhookをトリガーできません。