💁

Webhookサービス連携

⚠️

ヘルプページはこちらに移動しました。このページは更新されていませんので、最新の内容は上記よりご参照ください。

はじめに設定イベントタイプ Webhook URLの準備 Webhook URL設定数の上限に関してリクエストレスポンスエラーの通知内容リクエストボディ日程確定 (event.confirmed)Response Body Payload Object Json Sample 日程確定のキャンセル(event.canceled)Response Body Payload Object Json Sample ログの提供

はじめに

💡

Webhookサービス連携はSpirで特定のイベント発生時に、指定したURLにPOSTリクエストします

使用例

Zapier、IFTTT等のアプリケーションと連携する

APIを通じて各サービスを連携させることが可能です

例：日程確定時にSalesforceと連携する

Spirでは日程が確定した際、デフォルトの通知は主催者・参加者へのメール通知のみですが、webhookを活用することで外部のサービスと連携することが可能です

設定

💡

1. 対象のイベントをイベントタイプから決める 2. webhookURLの準備 3. WebhookURLと対象のイベントをこちらのフォームからお知らせください

イベントタイプ

日程確定 (event.confirmed)

日程確定のキャンセル（event.canceled）

空き時間URLのみが対象
すべての空き時間URLがwebhookの送信対象になります（個別に設定することはできません）

Webhook URLの準備

Webhookサービス連携には、Spirからのリクエストを受信できるhttpsエンドポイント（以下、WebhookURL）を準備する必要があります

WebhookURLは、以下の点にご注意ください

HTTPS通信

localhostのURLは不可

IPアドレスは使用不可

有効なWebhookURLの例

https://example.com/callback-confirmed

Webhook URL設定数の上限に関して

1イベントに対して1つのWebhook URLを登録

1イベントに対して2つ以上のURLを登録したい場合はお問い合わせください

リクエスト

SpirはPOSTメソッドでリクエストしますリクエストボディはJSONオブジェクトに基づいており、イベントタイプによって異なりますリクエストの詳細はこちら

レスポンス

💡

設定したWebhookURLが、Spirからリクエストを受信したとき、ステータスコード200のレスポンスを返却してください

以下の場合、Webhookの送受信に失敗したと見なされます

WebhookURLがステータスコード3xx、4xxまたは5xxのHTTPレスポンスを返却した場合

システムへの接続がタイムアウトした場合（リクエストは30秒でタイムアウト）

失敗した場合

10秒ごとに4回リトライします

最後のリクエストが失敗した場合エラーの通知をします

エラーの通知内容

通知方法メール通知

通知先チームの管理者全員

メールタイトル

【Spir】Webhookの送信に失敗しました。

メール通知内容

空き時間URLの管理用タイトル

WebhookURL

送信時刻

HTTPレスポンスなどの送信ログ

（送信ログにつきましては添付ファイルに記載されます。）

リクエストボディ

リクエストボディはJSONオブジェクトに基づいており、イベントタイプによって異なります

日程確定 (event.confirmed)

Response Body

データ型	必須	説明
string	true	Webhookのイベントタイプ。
string	ture	Webhookのイベントごとに一意のid。
Object	true

Payload Object

データ型	必須	説明
string	true	確定に利用された空き時間URL。空き時間URLを一意に特定するのに利用できます。
string	true	確定に利用された空き時間URLの管理用タイトル。
string	true	日程調整を確定した日時。（確定した予定の日時ではありません。）
string	true	予定のタイトル。
string	true	予定の開始日時。
string	true	予定の終了日時。
string	true	予定の確定者のタイムゾーン。
Object	true	予定の主催者。（空き時間URLに設定されている主催者）
Array	true	予定の主催者側の同席者。
Object	true	予定の確定者。（空き時間URLを受け取って日程を選んだ人）
Array	true	予定の確定者側の同席者。
Object	true	予定のWeb会議。
Array	true	空き時間URLに設定されているフォームの回答。
Object	false	UTMパラメータ UTMパラメータが付与された空き時間URLで確定された場合、Payloadに値が含まれます。

Json Sample

日程確定のキャンセル(event.canceled)

Response Body

データ型	必須	説明
string	true	Webhookのイベントタイプ。
string	ture	Webhookのイベントごとに一意のid。
Object	true

Payload Object

データ型	必須	説明
string	true	確定に利用された空き時間URL。空き時間URLを一意に特定するのに利用できます。
string	true	確定に利用された空き時間URLの管理用タイトル。
string	true	日程調整を確定した日時。（確定した予定の日時ではありません。）
string	true	予定のタイトル。
string	true	予定の開始日時。
string	ture	予定の終了日時。
string	true	予定のタイムゾーン。
Object	true	予定の主催者。（空き時間URLに設定されている主催者）
Array	true	予定の主催者側の同席者。
Object	true	予定の確定者。（空き時間URLを受け取って日程を選んだ人）
Array	true	予定の確定者側の同席者。
Array	true	空き時間URLに設定されているフォームの回答。
string	true	予定をキャンセルした理由。
string	true	予定をキャンセルした日時。

Json Sample

ログの提供

お問い合わせください

Post on X