webhookでほかのアプリにデータを送信する

連携

webhookでほかのアプリにデータを送信する

新しいリードや請求書の支払いなどが発生した瞬間に、署名付きのメッセージを指定のアドレスに送信します。

場所: 設定 → 開発者とAPI → webhook オーナーと管理者 5分

始める前に

POSTリクエストを受け付ける、自社サーバー上のhttpsアドレス。

仕組み

しくみを順を追って説明します

CompanyFlowHQ: 新しいリード、請求書の支払いなどが発生
CompanyFlowHQ → サーバー: 署名付きのメッセージを指定のhttpsアドレスに送信します
サーバー: whsec_シークレットで署名を検証します
サーバー → CompanyFlowHQ: 数秒以内に2xxで応答します

手順の概要

ステップ1/4

メニューの設定をタップし、セクションへ移動の行で開発者とAPIをタップします（または開発者の欄まで下にスクロールします）。
webhookでアドレス（httpsのみ）を入力し、送信するイベントで送信する内容にチェックを入れます。webhookを追加をタップします。
シークレットをコピー（whsec_で始まります）をタップし、続けて完了をタップします。
テストを送信をタップします。結果はイベント／結果／日時に表示されます。

コードの例

画面の例送信される署名ヘッダー

確認する場所： すべてのWebhookリクエスト貼り付ける場所： 自社サーバーでwhsec_署名シークレットを使って検証します

✅ うまくいったかを確認するには

テスト結果が緑色で表示され、自社サーバーにメッセージが届きます。

⚠️ よくある間違い

問題配信に失敗する。対処法指定のアドレスは数秒以内に2xxで応答する必要があります。修正したら再試行をタップしてください。

問題アドレスがhttp://で始まっている。対処法使用できるのはhttpsのアドレスのみです。