外部サービス連携（Webhook）
外部サービス連携（Webhook）とは
外部サービス連携（Webhook）は、コングラントで特定のイベントが発生した際に、そのデータをリアルタイムで他のアプリケーションに送信する機能です。これにより、コングラントのデータをCRM（Kintoneなど）に登録する、チャットツール（Slackなど）に通知を送るなど、様々な外部サービスとの連携が可能になります。
※外部サービス連携（Webhook）機能はスタンダードプラン以上でご利用いただけます。
できること
コングラントのWebhook機能を使うことで次のような自動化が可能になります。
● 新規の寄付が行われたら…
- Gmailから自動で定型文のお礼メールをサポーターに送信
- Slack（チャットツール）の新規寄付通知チャンネルでファンドレイジングチームに通知
- Trello（タスク管理）に新規サポーター向けの郵送物発送のタスクを登録
- kintone（CRM）のサポーター・寄付テーブルに新規レコードを登録
- メルマガサービスのコンタクトリストに登録
● 継続寄付が解約されたら…
- kintone（CRM）の該当の継続契約のステータスを「停止」に変更
- Slack（チャットツール）の解約通知チャンネルでファンドレイジングチームに通知
- メルマガサービスのコンタクトリストから削除
これらの業務がリアルタイムかつ自動で処理されるので、寄付に関する事務作業を大幅に削減できます。
※Webhookで各種外部サービスとの連携を行うためには通常「iPaaS」という連携サービスを別途利用する必要があります
連携の仕組み
Webhookとは
コングラントの外部サービス連携機能は「Webhook」と呼ばれる仕組みを利用しています。Webhookとは、異なるサービスやシステム間でリアルタイムに情報を送信するための仕組みです。
コングラントでは、新規寄付申込、継続寄付の自動決済・解約、銀行振込や郵便振替の手動消込が行われた時にwebhookで必要な情報を外部に送信することができます。
コングラントのWebhook単体では外部サービスとの自動連携はできません。Webhook通知の内容をもとに各種サービスに合わせて連携処理が行われる仕組みを構築する必要があります。
コングラントでは専門知識がなくてもローコード・ノーコードで連携ができる「iPaaS」を利用いただくことを推奨しています。
iPaaSとは
iPaaS（インテグレーション・プラットフォーム・アズ・ア・サービス）とは、複数のクラウドサービス間の連携を一元管理できるサービスです。コードを使わず（ノーコード・ローコード）、非エンジニアでも複数の異なるサービス間を自動連携させることができます。
コングラントと外部サービスを連携させるためには、iPaaSを利用してコングラントからのWebhook通知をトリガーに、kintoneにレコードの登録、Slackに通知などの処理を自動化させてください。
※iPaaSの設定作業に関してはコングラントのサポート対象外となります。あらかじめご了承ください。
設定の流れ
下記の手順でコングラントと外部サービスをWebhookを使って連携させることができます。
- コングラントのスタンダードプランを契約
外部サービス連携機能はスタンダードプラン以上でご利用いただける機能です。お試し・フリー・ライトプランをご利用の場合はスタンダードプランにアップグレードを行なってください。
- iPaaSサービスを契約
Webhookを使って外部サービスとの連携を行う際、iPaaSの利用を推奨しています。
- iPaaS側で外部サービスとの連携設定（トリガー・条件・データのマッピングなど）
iPaaSではさまざまなトリガー、条件を設定することができます。また、連携先のサービスにコングラントから送信されたどの情報をどこに連携するのか、マッピング作業も必要です。
詳細は各種iPaaSサービスのマニュアルをご確認ください。
- iPaaSサービスからWebhook URLを取得
設定ができたら、iPaaSサービスからWebhook URLを取得します。これは、コングラントから送信されるWebhookの通知先のURLになります。
取得方法は各種iPaaSサービスのマニュアルをご確認ください。
- コングラント管理画面の基本設定＞外部サービス連携で、Webhook URLを入力
iPaaSから取得したWebhook URLをコングラントの基本設定＞外部サービス連携で登録します。
- 連携完了
Webhook URLを登録するとコングラントからダミーデータが送信され、連携テストが行われます。正常にメッセージが表示されたら連携設定は完了です。
※Webhook連携の設定を行う際は、下記のリファレンスで仕様詳細をご確認ください。
詳細仕様
2025年10月時点で、webhook機能はβ版として提供しています。
2026年春頃を目処に正式版（ver.2）をリリース予定です。
Webhook URL
Webhook URLにはHTTPSのURLのみ使用可能です。HTTPは使用できません。
イベントトリガー
下記のイベントをトリガーにWebhook通知を送信します。
- 単発決済（申込時）
- 継続決済（申込時、自動決済時、再決済時）
- 継続決済の解約
- 管理画面からの入金消込（銀行振込、郵便振替）
※2025年10月時点でGOJO経由の寄付は連携対象外となります（2025年11月以降で対応予定）
リクエストボディ
WebhookではPOST形式でリクエストを行います。
Content-Type : application/json
リクエスト例:
リクエスト例（複数プラン同時決済の場合）:
フォーマット:
| プロパティ | データ型 | 備考 | 値域 / 形式 |
|---|---|---|---|
| event_id | string | イベントトリガーの種類（ID） | ※イベント一覧を参照 |
| event_type | string | イベントトリガーの種類（名称） | ※イベント一覧を参照 |
| payment_no | string | 決済No. | |
| paid_at | string | 受領日（決済が完了した日） | yyyy-MM-dd HH:mm:ss |
| deposit_date | string | 入金日（銀行振込や郵便振替の場合の入金日） | yyyy-MM-dd |
| payment_type | string | 決済頻度 | 単発, 毎月, 毎年 |
| project_id | string | プロジェクトID | |
| project_name | string | プロジェクト名 | |
| plan_name | string | プラン名 | |
| unit_price | string | 単価（1口あたりの金額） | |
| quantity | string | 口数（購入した単位数） | |
| amount | string | 金額（単価 × 口数） | |
| payment_detail | array | 複数のプランを同時に決済した場合、内訳を配列で送信。 ※詳細は下記の表参照 | |
| support_route_id | string | 支援ルートID | |
| support_route_name | string | 支援ルート名 | |
| support_comment | string | 応援コメント（ユーザーが入力したコメント） | |
| support_comment_publication | string | 応援コメントの公開設定 | 公開, 非公開, 非公開希望 |
| receipt_status | string | 領収書発行ステータス | 未作成, 未発行, 発行済み, 無効 |
| recurring_no | string | 継続契約番号（継続決済に紐づくID） | |
| recurring_status | string | 継続契約ステータス | 有効, 解約, エラー |
| recurring_last_failure_date | string | 最終決済失敗日（継続決済失敗時のみ送信） | |
| recurring_retry_failure_count | string | 自動リトライ回数（継続決済失敗時のみ送信） | |
| supporter_no | string | サポーター番号 | |
| entity_type | string | 会社タイプ | 個人, 法人, 匿名 |
| organization_name | string | 法人名 | |
| organization_name_kana | string | 法人名（フリガナ） | |
| department_and_title | string | 担当者部署・肩書き | |
| last_name | string | 氏名（姓） | |
| first_name | string | 氏名（名） | |
| last_name_kana | string | フリガナ（セイ） | |
| first_name_kana | string | フリガナ（メイ） | |
| name_publication | string | 広報物への氏名掲載 | 許可する, 許可しない |
| gender | string | 性別 | 男性, 女性, その他, 無回答 |
| birth_date | string | 生年月日 | yyyy-MM-dd |
| string | メールアドレス | ||
| phone_number | string | 電話番号 | |
| postal_code | string | 住所（郵便番号） | |
| country | string | 住所（国） | |
| prefecture | string | 住所（都道府県） | |
| city | string | 住所（市区町村） | |
| address_line | string | 住所（番地以降） | |
| has_shipping_address | string | 郵送物送付先を別途指定するか | 指定する, 指定しない |
| shipping_country | string | 郵送物送付先（国） | |
| shipping_postal_code | string | 郵送物送付先（郵便番号） | |
| shipping_prefecture | string | 郵送物送付先（都道府県） | |
| shipping_city | string | 郵送物送付先（市区町村） | |
| shipping_address_line | string | 郵送物送付先（番地以降） | |
| shipping_organization_name | string | 郵送物送付先（会社名・所属） | |
| shipping_recipient_name | string | 郵送物送付先（宛名） | |
| shipping_permission | string | 郵送物送付の許可 | 許可する, 許可しない |
| shipping_copies | string | 郵送物送付の部数 | |
| custom_field_{items.id} | string | カスタム項目の値 | |
| webhook_timestamp | string | 連携データ送信日時（Webhook が送信された日時） | yyyy-MM-dd HH:mm:ss |
イベントトリガー・タイプ一覧：
| event_id | event_type | 説明 |
|---|---|---|
| 000 | テスト | 連携テストが行われた時 |
| 101 | 単発決済(クレジットカード) | 単発決済が行われた時 |
| 102 | 単発決済(PayPay) | PayPayで単発決済が行われた時 |
| 103 | 単発決済(AmazonPay) | AmazonPayで単発決済が行われた時 |
| 201 | 申し込み(銀行振込) | 銀行振込での寄付申込みが行われた時 |
| 202 | 申し込み(郵便振替) | 郵便振替での寄付申込みが行われた時 |
| 401 | 継続寄付初回(クレジットカード) | 初回の継続寄付が行われた時 |
| 501 | 継続寄付初回以外(クレジットカード) | 2回目以降の継続決済が完了した時 |
| 601 | 継続寄付失敗(クレジットカード) | 継続決済が失敗した時 |
| 701 | 継続寄付の解約(クレジットカード) | 継続寄付が解約された時 |
| 801 | 入金消込(銀行振込) | 団体が管理画面から銀行振込の入金消込操作を行なった時 |
| 802 | 入金消込(郵便振替) | 団体が管理画面から郵便振替の入金消込操作を行なった時 |
payment_detail 配列の要素（詳細）:
| プロパティ | データ型 | 備考 | 値域 / 形式 |
|---|---|---|---|
| payment_no | string | 決済No | |
| plan_name | string | プラン名 | |
| unit_price | string | 単価 | |
| quantity | string | 口数 | |
| receipt_status | string | 領収書発行ステータス | 未作成, 未発行, 発行済み, 無効 |
レスポンス
コングラントのWebhookからリクエストを受け取ったサービス・システムからのレスポンスのステータスコードをもとに成否を判断します。
- 成功: ステータスコード200
- 失敗: ステータスコード4XX、5XXまたはタイムアウト
エラー発生後の再連携
- エラーが発生した場合、その後のWebhook通知は停止されます
- エラー解消後、コングラントの基本設定＞外部サービス連携画面から新たなWebhookURLを登録するまたは、連携テストを実行してリクエストが成功すると連携が再開されます
- 連携停止中に発生したイベントデータは、再連携後に自動で送信されます