API から実行する
Zapier・n8n・社内ツールなど外部のシステムから、API でオートメーションを実行する
オートメーションはスケジュールで自動実行されるほか、Squadbase API から好きなタイミングで実行できます。外部のシステムで何かが起きたときに、すぐにレポートを作って届けられます。
こんなときに使う
- イベントをきっかけにしたレポート — 商談の成立、フォームの送信、スプレッドシートへの行の追加などをきっかけに、オートメーションを実行して結果を届けます
- ワークフローの一部として — Zapier・n8n・Make などのワークフローの 1 ステップとしてオートメーションを組み込みます
- 社内ツールから — 社内アプリに「レポートを作成」ボタンを置き、押されたらオートメーションを実行します
必要なもの
- API キー — サイドバー左上の組織名をクリックし、設定 → APIキー から作成します。詳しくは 認証 を参照してください
- プロジェクトID —オートメーションを開いたときの URL の
project/に続く ID です - オートメーションの識別子 — 同じ URL の
automation=に続く名前です
https://app.squadbase.dev/space/…/project/<プロジェクトID>/ai?editorTab=automation&automation=<オートメーションの識別子>API キーを作成したユーザーが、そのプロジェクトの Creator 以上である必要があります。Viewer のキーでは実行できません。
実行のしかた
次のリクエストでオートメーションを実行します。
curl -X POST 'https://api.squadbase.dev/v0/automation/<PROJECT_ID>/<AUTOMATION_NAME>/trigger' \
-H 'x-api-key: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{}'API はすぐに応答を返し、オートメーションはその後バックグラウンドで実行されます。通知のステップがあれば、スケジュール実行と同じように結果が届きます。
応答に含まれる executionId を使うと、プログラムから実行の状態や結果を確認できます。
ワークフローツールが失敗したリクエストを自動で再送する場合は、Idempotency-Key ヘッダーを付けてください。同じキーの再送では新しい実行は始まらず、最初の実行が返ります。
リクエスト・レスポンスの詳細、エラーコード、Python・Node.js の例は API 概要 を参照してください。
制限
- 同じオートメーションが実行中のときは、新しく実行できません。今の実行が終わってから呼び出してください
- API での実行は、チームごとに 1 時間あたり 60 回までです（プランによって上限が異なります）
- AIクレジットの残高が 0 のときは実行できません
- API での実行も、スケジュール実行と同じく AIクレジットを消費します。詳しくは オートメーションのクレジット消費 を参照してください