メインコンテンツへスキップ
POST
/
v1
/
integrations
/
zapier
/
webhook

curl -X POST "https://api.caret.so/v1/integrations/zapier/webhook" \
     -H "X-API-Key: your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "hookUrl": "https://hooks.zapier.com/hooks/catch/123456/abcde/"
     }'

{
  "status": "success"
}

概要

このエンドポイントは、ワークスペースに新しいZapier Webhook URLを登録します。登録後、Caretは新しいミーティングが作成されるたびにこのURLに通知を送信します。 これは主にCaret Zapier連携で「Instant」トリガーを設定するために使用されます。

認証

すべてのAPIリクエストには、X-API-Key HTTPヘッダーにAPIキーを含める必要があります。
X-API-Key
string
必須
Caret APIキー。

Body

hookUrl
string
必須
通知を送信するZapierが提供するWebhook URL。https://で始まる有効なURLである必要があります。

レスポンス

status
string
操作の結果を示します。Webhookが登録された場合は常にsuccess

curl -X POST "https://api.caret.so/v1/integrations/zapier/webhook" \
     -H "X-API-Key: your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "hookUrl": "https://hooks.zapier.com/hooks/catch/123456/abcde/"
     }'

{
  "status": "success"
}