Skip to main content
POST
/
v1
/
integrations
/
zapier
/
webhook

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

Overview

This endpoint registers a new Zapier webhook URL for your workspace. Once registered, Caret will send notifications to this URL whenever a new meeting is created. This is primarily used by the Caret Zapier integration to set up “Instant” triggers.

Authentication

All API requests must use Authorization: Bearer <API_KEY>.
Authorization
string
required
Bearer token. Format: Bearer <API_KEY>.

Body

hookUrl
string
required
The webhook URL provided by Zapier where notifications should be sent. Must be a valid URL.

Response

status
string
Indicates the result of the operation. Always success if the webhook was registered.

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