外部サービスとの連携

Formia のデータを、基幹システムなどの外部サービスへ渡したいことがあります。この記事では、連携の入口である「連携」画面と、自動化から Webhook を送る方法を説明します。

連携の画面

設計モードの「管理」の「連携と外部データ」タブに、「連携（Webhook・API）」があります。3 つのタブで管理します。

タブ	内容
Webhook	登録したデータを、他のシステムへ送る設定
個人トークン	API を使うための個人用の鍵
API クライアント	システム間の連携に使う鍵

Webhook を登録する

1. 「Webhook を追加」を押します。
2. 名前と送り先の URL を決めます。
3. 送るイベントと、対象のデータ（アプリ）を決めます。
4. 保存します。

送り先 URL は、原則として https です。社内ネットワーク宛ての http は使えます。署名で、送ったデータが Formia からのものだと確かめられます。失敗したときは、間隔をあけて再送されます。「配信ログ」で、送った結果を確認できます。

自動化から送る

自動化の「すること」で「Webhook を送る」を選ぶと、登録した送り先へ送れます。たとえば、承認が終わったら基幹システムへ送る、という使いかたです。

登録した Webhook は、自動化の一覧に「連携の Webhook」の札で並びます。ここからは読むだけで、押すと連携の画面へ移ります。

送れる主な出来事

• レコードが作られた、送信が確定した、直された、消された
• ワークフローの状態が変わった、期限を過ぎた
• フォームが公開された
• 自動化から送った

API で使う

外部のシステムから Formia のデータを読み書きしたいときは、API を使います。トークンと権限の扱いは API のトークンと権限 を見てください。

関連する記事

• Webhook で通知する
• API のトークンと権限
• REST API
• すること（アクション）の種類