アプリ一覧にない外部サービスと連携する(Webhook・HTTPリクエスト)

アプリ一覧に連携したいサービスが見つからない場合でも、そのサービスがWebhookの送信やAPIを提供していれば、ユーティリティのピースを使って連携できることがあります。このページでは、連携できるかの確認手順と、使うピースの選び方を説明します。
連携できるかどうかは、連携先サービスの仕様や契約プランによって異なります。このページは、特定のサービスとの連携を保証するものではありません。具体的な設定値は、連携先サービスの公式ドキュメントをご確認ください。

1. アプリ一覧をもう一度確認する

  • 製品名で検索し、ご利用中のサービスと正式名称が一致しているかを確認してください。同じ会社が提供する別製品(例:会計サービスと請求書発行サービス)は、別のアプリとして扱われます。
  • アプリはあるのに、やりたい操作(アクション・トリガー)がない場合は、そのアプリに「カスタムAPI呼び出し」ピースがあるか確認してください。接続済みの認証情報を使って、標準にないAPIを呼び出せます。

2. 連携先サービスの仕様を確認する

確認すること確認する場所の例分かること
Webhook(通知URLへの送信)機能があるか連携先の管理画面・ヘルプの「Webhook」「通知設定」連携先の出来事をきっかけに、workrunのフローを起動できるか
APIが公開されているか連携先の開発者向けドキュメントworkrunから連携先のデータを取得・登録できるか
APIやWebhookの認証方式同上の「認証」「署名」の項目workrunのピースで設定できる方式か
利用できるプラン連携先の料金プランプランによってはAPI・Webhookを使えない場合がある
IPアドレス制限の有無連携先のセキュリティ設定workrunの固定IPアドレスの許可が必要か

3. 使うピースを選ぶ

やりたいこと使うピース
連携先で何か起きたときにフローを開始したいWebhookをキャッチする(トリガー)
フローの途中で連携先のデータを取得・登録したいHTTPリクエストを送信
連携先のAPIがOAuth 2.0認証を必要としているHTTP (OAuth2) の「OAuth2リクエストを送信」
一覧にあるアプリで、標準にない操作をしたい各アプリの「カスタムAPI呼び出し」
  • 「Webhookをキャッチする」の受信認証は、なし/ベーシック認証/ヘッダー認証/HMAC署名から選べます。連携先の送信仕様と一致するかをご確認ください。
  • 「HTTPリクエストを送信」の認証は、なし/ベーシック認証/Bearerトークンから選べます。APIキーをヘッダーで渡す方式は、Headersに指定します。
  • 「OAuth2リクエストを送信」は、事前に作成したOAuth 2.0の接続を使ってリクエストを送ります。連携先の認証仕様によっては接続できない場合があります。

4. 連携が難しい場合

  • WebhookもAPIも提供されていない場合、workrunから直接連携することは難しくなります。

関連ページ