🧑🏼💻
Webhookを送りたい(開発者向け)
Webhookを利用するには、チームプランへの加入が必要です。
Webhookの設定方法
- 機能を追加ページにアクセスし、WebhookをONにします。調整ページの設定フォームにWebhookが追加されます。
- ページ作成時にWebhookを指定します。
| URL | Webhookを送信するエンドポイントです。https://で始まる必要があります。開発時はngrokなどを使用してください。 |
| セキュリティトークン | Webhookの送信元がNitteであることを検証するためのトークンです。複数ページで共通のトークンが使いたい場合のために、手動の設定も可能です。 |
フォームが設定できたら、を使って、サンプルデータで送信をテストできます。
リクエスト
ヘッダー
に設定したセキュリティトークンが入ります。
Webhook受信時にこのトークンが一致していることを確認するようにしてください。
ボディ
イベント(event)
発生したイベントのキーです。
| 値 | イベント |
| confirm | 確定 |
| reschedule | 日程変更 |
| cancel | キャンセル |
予約情報(booking)
予約に関する情報です。
| プロパティ | 型 | 概要 |
| id | String | 予約のIDです。重複のない予約の一意な値です。 |
| pageId | String | 予約ページのIDです。 この値は日程調整URLの末尾の値と同じです。 例) https://nitte.app/xxxx/70d164f8の場合→70d164f8 |
| startDateTime | String(ISO8601) | 予定の開始日時(UTC)です。 |
| endDateTime | String(ISO8601) | 予定の終了日時(UTC)です。 |
| location | Location | 場所の情報を参照してください。 |
| calendarEventUrl | String | カレンダーの予定のURLです。 |
| rescheduledUserName | String | 日程変更したユーザーの名前です。eventがrescheduleの時のみ入ります。 |
| rescheduleMessage | String | 日程変更したユーザーのメッセージです。eventがrescheduleの時のみ入ります。 |
場所の情報(booking.location)
場所によってリクエストが異なります。
- Google Meetの場合
- Zoomの場合
- Teamsの場合
- テキストの場合
- オフラインの場合
フォーム(form)
予約時に入力されたフォームの情報です。
| プロパティ | 型 | 概要 |
| name | String | 名前 |
| companyName | String | 会社名 |
| String | メールアドレス | |
| message | String | メモ |
日程変更フォーム(event = reschedule)の場合のみ
| プロパティ | 型 | 概要 |
| name | String | 名前 |
| message | String | メッセージ |
キャンセルフォーム(event = cancel)の場合のみ
| プロパティ | 型 | 概要 |
| name | String | 名前 |
| message | String | メッセージ |
参加者(users)
予定の参加者のユーザー情報の配列です。
| プロパティ | 型 | 概要 |
| name | String | 名前(アカウント設定で設定されているもの) |
| String | メールアドレス |
レスポンス
Webhookを受け取ったサーバーはステータスコード200を返却してください。
200以外のステータスコードが返却された場合は、1秒待って3回までリトライします。