API

API と Webhook

フォームと回答を、自分たちの仕組みから読み書きできます。回答が届いた瞬間を受け取ることもできるので、こちらから定期的に見に行く必要はありません。

はじめかた

Halict にログインし、設定 → API キーでキーを発行します。キーは qk_live_ で始まり、発行したときに一度だけ表示されます。

呼ぶときは Authorization ヘッダに載せます。キーは1つのワークスペースに属します。

curl https://halict.com/api/forms \
  -H "Authorization: Bearer qk_live_xxxxxxxx"

主な口

住所はどれも https://halict.com/api から始まります。

GET	/forms	フォームの一覧
POST	/forms	フォームを下書きで作る
PATCH	/forms/{id}	題・説明・公開状態を変える
GET	/forms/{id}/responses	届いた回答の一覧（絞り込みあり）
GET	/forms/{id}/stages	対応の段階
GET	/responses/{id}	回答1件の明細
PATCH	/responses/{id}	段階・担当者・付箋を変える
POST	/responses/{id}/notes	内部メモを足す
GET	/members	担当者に指定できる人
POST	/webhooks/subscribe	出来事の知らせを受け取る

回答の一覧に flat=1 を付けると、答えが設問の見出しを鍵にした形で入ります。下の知らせと同じ形なので、繋ぐ側は1つの形だけ覚えれば足ります。

出来事を受け取る

見に行く代わりに、受け取る住所を登録します。回答が届いたとき（response.created）と、回答の段階が変わったとき（response.stage_changed）に知らせが飛びます。

curl -X POST https://halict.com/api/webhooks/subscribe \
  -H "Authorization: Bearer qk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "formId": 12,
    "event": "response.created",
    "targetUrl": "https://example.com/hooks/halict"
  }'

登録した住所には、この形で届きます。

{
  "event": "response.created",
  "form": { "id": 12, "title": "Trial lesson application" },
  "responseId": 345,
  "submittedAt": "2026-09-18T01:00:00.000Z",
  "stage": null,
  "respondent": { "name": "Hanako Yamada", "email": "[email protected]" },
  "answers": {
    "Name": "Hanako Yamada",
    "Preferred day": "Sunday"
  },
  "summary": "■ Name\nHanako Yamada\n\n■ Preferred day\nSunday",
  "link": "https://halict.com/forms/12/responses?open=345"
}

要らなくなったら、返ってきた札を使って DELETE /webhooks/subscribe/{id} で消します。

仕様書

全部の口をまとめた仕様書を OpenAPI 3.1 で公開しています。halict.com/api/openapi.json

ログインは要りません。ChatGPT や Claude にそのまま読ませて、繋ぐところを書かせることもできます。

できあいの連携

自分で書かなくても繋げます。n8n は公式のノード（n8n-nodes-halict）を公開していて、設定画面から入れるだけで使えます。Zapier の連携も同じ口の上に作ってあります。

フォームごとの通知設定からは、Slack・Teams・Discord・Chatwork・Google スプレッドシート・任意の URL へそのまま送れます。

AI から使う

Halict は MCP に対応しています。ChatGPT や Claude の設定に https://halict.com/mcp を足してログインすると、会話しながらフォームを作ったり、届いた回答を読んだりできます。AI はあなたと同じ権限の範囲でだけ動きます。

繋ぎ方で迷ったらお問い合わせからどうぞ。