本文へスキップ

ガイド

連携の概要:API、Webhook、Zapier

自動化と連携 · 読了まで4分

Mateflow では、コミュニティを 3 つの方法で他のツールと連携できます。接続済みアプリ(Slack、Discord、Zapier)、独自のサーバーへの Webhook、開発者向けの Open API です。3 つとも、管理画面の 1 つのページ(管理画面 → 設定 → 連携)にまとまっています。

対象者:オーナーと管理者。 · 場所:ウェブ(管理画面)。 · プラン:Webhook、API アクセス、1 日あたりの API リクエスト数の上限は、プラットフォームプランによって異なります。

管理画面で連携の設定を見つける

管理画面 → 設定 → 連携に移動します。ページ名は連携 & API で、4 つのタブがあります。

タブ できること
連携 接続済みアプリで Slack、Discord、Zapier を接続します
Webhook コミュニティのイベントを独自のエンドポイントに送ります
API アクセス API キーを作成・無効化し、開発者向けドキュメントを開きます
配信ログ Mateflow が Webhook、アプリ、自動化ルールに送ったすべてのリクエストを確認します

Slack、Discord、Zapier を接続する

接続済みアプリは、新しいメンバー、投稿、支払いなどのコミュニティのイベントを別のサービスにプッシュします。

  • Slack:Incoming Webhook の URL を通じて、チャンネルにメッセージを投稿します。
  • Discord:Discord の Webhook URL を通じて、チャンネルにメッセージを投稿します。メッセージを送るだけで、メンバーやロールは同期しません。
  • Zapier:イベントを Zapier の Catch Hook に送ります。Zap を使って、ほかの数千のアプリにイベントを渡せます。

接続するには、連携タブを開き、Slack を接続、Discord を接続、Zapier を接続のいずれかをクリックします。そのサービスの Webhook URL を貼り付け、プッシュするイベントを選び、必要に応じて署名シークレット(任意) を追加して、接続をクリックします。次に、テストイベントを送信をクリックして、メッセージが届くことを確認します。

接続済みのカードには、プッシュしているイベントが表示されます。カードのメニューから、設定を編集、テストイベントを送信、接続を切断を選べます。

Webhook で独自のサーバーにイベントを送る

Webhook は、選んだイベント(メンバー参加、アクセスグループへのメンバー追加、投稿作成、支払い受領など)が発生するたびに、あなたが管理するエンドポイントに HTTPS リクエストを送ります。各 Webhook には、独自のイベント、任意の署名シークレット、有効のスイッチがあります。Webhook を使えるかどうかと、作成できる数は、プラットフォームプランによって異なります。Webhook を設定するを参照してください。

Open API で独自の連携を作る

Open API を使うと、開発者は自分のコードからコミュニティのデータを読み書きできます。投稿、スペース、メンバーの読み取り、投稿の作成、メディアのアップロード、招待の送信ができます。各 API キーは 1 つのコミュニティに属し、作成時に権限(スコープ)を選びます。API キーはクリエイターダッシュボード(app.mateflow.com)では管理しません。クリエイターダッシュボードのコミュニティの概要ページには、代わりにこの管理画面のページへのリンクがあります。

API で送る招待にはアクセスグループを含めることができ、相手は招待を承諾したときにそのアクセスグループを受け取ります。アクセスグループの仕組みを参照してください。

API の完全なリファレンスは mateflow.com/developers にあります。API アクセスタブでドキュメントを開くをクリックするとアクセスできます。リンクを開発者に送ってください。開発者はコミュニティのアカウントを持っている必要はありません。API キーを作成するを参照してください。

配信ログで送信リクエストを確認する

配信ログタブには、Webhook、接続済みアプリ、Trigger webhook を使う自動化ルールが送ったリクエストが一覧表示されます。イベントタイプ、結果、日付で絞り込み、詳細を表示をクリックすると、リクエストとレスポンスの全体を確認できます。配信ログは 30 日間保持されます。失敗した Webhook の配信は自動的に再試行されます。自分で再送するボタンはありません。

API キーを使って行われたリクエストは、ここには記録されません。代わりに、API アクセスタブに各キーの最終使用日が表示されます。

関連記事

このガイドは役に立ちましたか?

ガイド一覧に戻る

お探しのものが見つかりませんか?

コミュニティのメンバーの方は、そのコミュニティの管理者にお問い合わせください。Mateflowでコミュニティを構築・運営している方は、私たちのチームがサポートします。

無料で始める