🧑🏼‍💻

Webhookを送りたい(開発者向け)

💡
Webhookを利用するには、チームプランへの加入が必要です。

Webhookの設定方法

  1. 機能を追加ページにアクセスし、WebhookをONにします。調整ページの設定フォームにWebhookが追加されます。
 
  1. ページ作成時にWebhookを指定します。
    1. URLWebhookを送信するエンドポイントです。https://で始まる必要があります。開発時はngrokなどを使用してください。
      イベントどのイベントでWebhookを送信するかを指定します。 (※ 日程変更、キャンセルをOFFにしてる場合は、このフォームは表示されず、自動で確定のみになります)
      セキュリティトークンWebhookの送信元がNitteであることを検証するためのトークンです。複数ページで共通のトークンが使いたい場合のために、手動の設定も可能です。
      フォームが設定できたら、を使って、サンプルデータで送信をテストできます。
      とりあえずどんなリクエストが来るか確認したい場合はRequestbin のエンドポイントを利用するのが便利です。
       

リクエスト

ヘッダー

に設定したセキュリティトークンが入ります。
Webhook受信時にこのトークンが一致していることを確認するようにしてください。
 

ボディ

イベント(event)

発生したイベントのキーです。
イベント
confirm確定
reschedule日程変更
cancelキャンセル

予約情報(booking)

予約に関する情報です。
プロパティ概要
idString予約のIDです。重複のない予約の一意な値です。
pageIdString予約ページのIDです。 この値は日程調整URLの末尾の値と同じです。 例) https://nitte.app/xxxx/70d164f8の場合→70d164f8
startDateTimeString(ISO8601)予定の開始日時(UTC)です。
endDateTimeString(ISO8601)予定の終了日時(UTC)です。
locationLocation場所の情報を参照してください。
calendarEventUrlStringカレンダーの予定のURLです。
rescheduledUserNameString日程変更したユーザーの名前です。eventがrescheduleの時のみ入ります。
rescheduleMessageString日程変更したユーザーのメッセージです。eventがrescheduleの時のみ入ります。

場所の情報(booking.location)

場所によってリクエストが異なります。
  • Google Meetの場合
  • Zoomの場合
  • Teamsの場合
  • テキストの場合
  • オフラインの場合

フォーム(form)

予約時に入力されたフォームの情報です。
プロパティ概要
nameString名前
companyNameString会社名
emailStringメールアドレス
messageStringメモ
 

日程変更フォーム(event = reschedule)の場合のみ

プロパティ概要
nameString名前
messageStringメッセージ
 

キャンセルフォーム(event = cancel)の場合のみ

プロパティ概要
nameString名前
messageStringメッセージ

レスポンス

Webhookを受け取ったサーバーはステータスコード200を返却してください。
200以外のステータスコードが返却された場合は、1秒待って3回までリトライします。