> ## 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.

# Box SignのWebhook

> フォルダでBox Signリクエストイベントをリッスンし、Webhookを作成し、通知ペイロードを処理します。

export const MultiRelatedLinks = ({sections = []}) => {
  if (!sections || sections.length === 0) {
    return null;
  }
  return <div className="space-y-8">
      {sections.map((section, index) => <RelatedLinks key={index} title={section.title} items={section.items} />)}
    </div>;
};

export const RelatedLinks = ({title, items = []}) => {
  const getBadgeClass = badge => {
    if (!badge) return "badge-default";
    const badgeType = badge.toLowerCase().replace(/\s+/g, "-");
    return `badge-${badge === "ガイド" ? "guide" : badgeType}`;
  };
  if (!items || items.length === 0) {
    return null;
  }
  return <div className="my-8">
      {}
      <h3 className="text-sm font-bold uppercase tracking-wider mb-4">{title}</h3>

      {}
      <div className="flex flex-col gap-3">
        {items.map((item, index) => <a key={index} href={item.href} className="py-2 px-3 rounded related_link hover:bg-[#f2f2f2] dark:hover:bg-[#111827] flex items-center gap-3 group no-underline hover:no-underline border-b-0">
            {}
            <span className={`px-2 py-1 rounded-full text-xs font-semibold uppercase tracking-wide flex-shrink-0 ${getBadgeClass(item.badge)}`}>
              {item.badge}
            </span>

            {}
            <span className="text-base">{item.label}</span>
          </a>)}
      </div>
    </div>;
};

署名リクエストは非同期に実行されます。署名者はアプリ外も含め、いつでもリクエストを完了、拒否、または無視できます。保存先フォルダにWebhookを設定すると、それらのイベントが発生したときにアプリに通知されます。

## Sign関連のイベント

フォルダまたはドキュメントにリスナーを設定します。通常は、署名リクエストを作成するフォルダに設定し、そのフォルダでのすべてのリクエストに1つのWebhookで対応できるようにします。

リッスンできるイベントの例:

* `SIGN_REQUEST.COMPLETED`: 署名リクエストが完了した
* `SIGN_REQUEST.DECLINED`: 署名リクエストが拒否された
* `SIGN_REQUEST.EXPIRED`: 署名リクエストの有効期限が切れた
* `SIGN_REQUEST.SIGNER_EMAIL_BOUNCED`: 署名者のメールが差し戻された
* `SIGN_REQUEST.SIGNER_SIGNED`: 特定の署名者がリクエストに署名した
* `SIGN_REQUEST.SIGNATURE_REQUESTED`: 署名が署名者にリクエストされた
* `SIGN_REQUEST.ERROR_FINALIZING`: 署名リクエストを処理できなかった

トリガーの詳細な一覧は、[Webhookトリガー](/guides/webhooks/triggers)を参照してください。

## Sign Webhookの作成

Sign Webhookは、Boxの標準Webhookインフラストラクチャを使用しています。Box Signイベントを受信するためには、[Webhookの作成](/reference/post-webhooks)エンドポイントを呼び出します。呼び出しでは、署名リクエストを作成するフォルダに`target`を設定したうえで、受信する`SIGN_REQUEST.*`トリガーを列挙する必要があります。

<Warning>
  このAPIを使用するには、アプリケーションの \[**Webhookを管理する**] スコープが有効になっている必要があります。
</Warning>

```sh theme={null}
curl -i -X POST "https://api.box.com/2.0/webhooks" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "target": {
         "id": "12345",
         "type": "folder"
       },
       "address": "https://example.com/sign-webhooks",
       "triggers": [
         "SIGN_REQUEST.COMPLETED",
         "SIGN_REQUEST.DECLINED",
         "SIGN_REQUEST.EXPIRED"
       ]
     }'
```

上記以外のWebhookの作成方法 (開発者コンソールを使った方法やSDKの例など) については、[Webhookの作成 (v2)](/guides/webhooks/v2/create-v2) を参照してください。

## Signイベント通知の受信

Box Signイベントが発生すると、BoxからHTTP `POST`リクエストがユーザーの構成した`address`に送られます。このペイロードにはトリガーのほか、署名リクエストIDや署名者のメールアドレスなどのSign固有の`additional_info`が含まれます。また、署名リクエストの`source`ファイルも含まれます。

たとえば、署名リクエストが完了すると、Boxから以下のようなペイロードが送られます。

```json theme={null}
{
  "type": "webhook_event",
  "id": "eb0c4e06-751f-442c-86f8-fd5bb404dbec",
  "created_at": "2024-05-22T08:28:56-07:00",
  "trigger": "SIGN_REQUEST.COMPLETED",
  "webhook": {
    "id": "53",
    "type": "webhook"
  },
  "created_by": {
    "type": "user",
    "id": "226067247",
    "name": "John Q. Developer",
    "login": "johnq@dev.name"
  },
  "source": {
    "id": "73835521473",
    "type": "file",
    "name": "Contract.pdf",
    "item_status": "active"
  },
  "additional_info": {
    "sign_request_id": "123e4567-e89b-12d3-a456-426614174000",
    "signer_emails": [
      "johnq@dev.name",
      "signer@example.com"
    ],
    "external_id": ""
  }
}
```

エンドポイントは、`200`から`299`までのHTTPステータスコードに30秒以内に通知確認を送る必要があります。ペイロード全体の形式と配信の詳細については、[Webhook (v2)](/guides/webhooks/v2) を参照してください。通知がBoxから送信されたものかどうかを確認する方法については、[Box Webhook署名の検証](/guides/webhooks/v2/signatures-v2)を参照してください。

<RelatedLinks
  title="関連するAPI"
  items={[
{ label: translate("Create webhook"), href: "/reference/post-webhooks", badge: "POST" }
]}
/>

<RelatedLinks
  title="関連するガイド"
  items={[
{ label: translate("Create Box Sign request"), href: "/guides/box-sign/create-sign-request", badge: "GUIDE" },
{ label: translate("Webhook triggers"), href: "/guides/webhooks/triggers", badge: "GUIDE" },
{ label: translate("Create webhooks (v2)"), href: "/guides/webhooks/v2/create-v2", badge: "GUIDE" }
]}
/>