無料で始める
デモを予約
言語を選択
English Español Português Deutsch Français Italiano 日本語 中文 हिन्दी עברית العربية 한국어 Nederlands Polski Türkçe Українська Русский Magyar Română Български Čeština Ελληνικά Svenska Dansk Norsk Suomi Bahasa Indonesia Tiếng Việt Tagalog ไทย Latviešu Lietuvių Eesti Slovenčina Slovenščina Hrvatski Македонски Қазақша Azərbaycan Afrikaans বাংলা

Webhooks

Gary Leman

Webhooks により、Shifton は特定のイベントが会社で発生するたびに、外部システムへリアルタイム通知を送信できます。

概要

デベロッパーページの Webhooks タブでは、Shifton からの自動通知を受け取るウェブフックエンドポイントを作成できます。シフトの作成・従業員のクロックイン・スケジュールの公開などのイベントがアカウントで発生すると、Shifton は指定した URL にデータペイロードを送信します。これにより、外部システムが Shifton に対して継続的にポーリングする必要がなくなり、インテグレーションをより速く効率的にできます。

前提条件

要件詳細
ロールOwner または
エンドポイントウェブフックのペイロードを受け取るためのサーバー上の公開アクセス可能な URL
知識HTTP リクエストとウェブフックに関する基本的な理解（または開発者へのアクセス）

操作手順

Webhooks タブへのアクセス

Shifton screenshot
1
左サイドバーの インテグレーション をクリックします。
2
デベロッパー
ページに移動します。
3
Webhook
タブをクリックします。
4
ウェブフックが作成されていない場合は、パズルのイラストとともに空の状態が表示されます。

新しい Webhook の作成

Shifton screenshot
Shifton screenshot
1
「新しい Webhook」
ボタンをクリックします。
2
ウェブフックの設定を入力します。
フィールド説明
URLShifton がイベントデータを送信するエンドポイント URL
イベントこのウェブフックをトリガーする Shifton イベントを選択
アクティブウェブフックの有効・無効を切り替えるトグル
1
ウェブフックを保存します。
2
選択したイベントが発生するたびに、Shifton は指定した URL に HTTP POST リクエストを送信します。

既存の Webhook の管理

1
Webhooks タブに、作成されたすべてのウェブフックの一覧が表示されます。
2
ウェブフックをクリックして設定を編集します。
3
URL の変更、イベントの更新、アクティブステータスの切り替えができます。
4
ウェブフックを削除するには、削除オプションを使用します。

Webhook のテスト

1
ウェブフックを作成したら、Shifton で関連するイベントをトリガーします（たとえば、テストシフトを作成する）。
2
エンドポイントサーバーのログを確認して、ウェブフックのペイロードが受信されたことを確認します。
3
ペイロードが届いていない場合は、URL が正しく公開アクセス可能であることを確認します。

アクセス権限

Shifton screenshot
ロールWebhooks の表示Webhooks の作成・編集Webhooks の削除
Ownerはいはいはい
はいはいはい
Managerいいえいいえいいえ
Employeeいいえいいえいいえ

よくある質問

Q: シフトon はウェブフックのペイロードにどのフォーマットを使用しますか？
A: ウェブフックは JSON ボディとともに HTTP POST リクエストとして送信されます。各イベントタイプの正確なペイロード構造については API ドキュメントを参照してください。

Q: 同じイベントに複数のウェブフックを設定できますか？
A: はい、同じイベントをリッスンする複数のウェブフックを作成でき、それぞれ異なる URL を指定できます。

Q: ウェブフックが発火したときにサーバーがダウンしていたらどうなりますか？
A: エンドポイントに到達できない場合、ウェブフックの配信が失敗することがあります。リトライポリシーと失敗処理の詳細については API ドキュメントを確認してください。

Q: 特定の従業員やプロジェクトについてのみトリガーするようにウェブフックをフィルタリングできますか？
A: ウェブフックのイベント選択は通常、イベントタイプレベルです。特定の従業員やプロジェクトを処理するには、サーバー側で受信データをフィルタリングする必要があります。

Q: ウェブフックのエンドポイントを安全にするにはどうすればよいですか？
A: 受信リクエストが本当に Shifton からのものであることを確認するために、秘密トークンまたは署名の検証を使用することを検討してください。セキュリティに関する推奨事項は API ドキュメントを参照してください。

問題と解決策

問題考えられる原因解決策
ウェブフックが発火しないウェブフックが非アクティブに設定されているウェブフックを編集して「アクティブ」トグルが有効になっていることを確認する
エンドポイントがエラーを返すURL が間違っているかサーバーがダウンしているURL が正しく、サーバーが起動して公開アクセス可能であることを確認する
ペイロードが受信されないファイアウォールが受信リクエストをブロックしているShifton からの受信 POST リクエストを許可するようサーバーのファイアウォール設定を確認する
ウェブフックが発火するがデータが不完全間違ったイベントタイプが選択されているウェブフックを編集して正しいイベントが選択されているか確認する
既存のウェブフックがあるにもかかわらず空の状態が表示されるページが更新されていないWebhooks タブを更新して最新データを読み込む
「新しい Webhook」ボタンが表示されない権限が不足しているOwner または ロールを持っていることを確認する