API リファレンス
Zapier やその他のプラットフォーム向けの連携ガイド — 認証、エンドポイント、Webhook ペイロードについて。
Dashform API を使うと、フォームや回答を読み取ったり、Zapier やその他のプラットフォームから新規送信イベントを購読したりできます。
認証
Dashform は認証に OAuth 2.0 を使用します。すべての API リクエストには、有効なアクセストークンを含める必要があります。
Authorization: Bearer YOUR_ACCESS_TOKENOAuth エンドポイント
GET /api/oauth/authorize— 認可ページPOST /api/oauth/token— コードをトークンに交換
現在のユーザーを取得
GET /api/v1/me認証済みユーザーに関する情報を返します。
{
"id": "user_123",
"name": "John Doe",
"email": "john@example.com"
}フォーム一覧
GET /api/v1/forms認証済みユーザーが所有するフォームの一覧を返します。
[
{
"id": "form_123",
"name": "Contact Form",
"description": "Main contact form"
}
]Webhook（REST フック）
購読
POST /api/webhooks/zapier/subscribeフォームの回答イベントを購読します。
リクエストボディ:
{
"target_url": "https://hooks.zapier.com/...",
"form_id": "form_123",
"subscription_id": "sub_123"
}form_id と subscription_id は任意です。form_id を省略すると、すべてのフォームにわたる回答を購読できます。
レスポンス:
{
"id": "hook_123",
"status": "subscribed"
}購読解除
DELETE /api/v1/hooks/unsubscribe/:idWebhook 通知の購読を解除します。
{
"success": true,
"message": "Hook deleted successfully"
}フック一覧
GET /api/v1/hooksアクティブなすべての Webhook 購読を一覧表示します。
[
{
"id": "hook_123",
"form_id": "form_123",
"target_url": "https://hooks.zapier.com/...",
"status": "active"
}
]トリガー
GET /api/v1/triggers/new-submissionトリガーをテストするための最近のフォーム回答を取得します。最新の 3 件の回答を返します。
クエリパラメーター:
form_id— 任意: 特定のフォームで絞り込み
[
{
"id": "reply_123",
"form_id": "form_123",
"form_name": "Contact Form",
"data": {
"name": "John Doe",
"email": "john@example.com"
},
"created_at": "2025-01-01T12:00:00Z"
}
]Webhook ペイロード
新しいフォーム回答を受信すると、Dashform は以下のペイロードを含む POST リクエストを Webhook URL に送信します。
{
"id": "reply_123",
"form_id": "form_123",
"form_name": "Contact Form",
"data": {
"name": "John Doe",
"email": "john@example.com",
"message": "Hello!"
},
"created_at": "2025-01-01T12:00:00Z"
}