GuidesAPI ReferenceZapier API

Subscribe to Webhook

Create a new webhook subscription for Zapier triggers. Stores the webhook URL and trigger configuration for automatic notifications.

POST
/api/webhooks/zapier/subscribe

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication for Zapier API access

In: header

Query Parameters

org_id*string

Organization ID

user_id*string

User ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://webhooks.sophiie.ai/api/webhooks/zapier/subscribe?org_id=org_1234&user_id=usr_1234" \  -H "Content-Type: application/json" \  -d '{    "hookUrl": "https://hooks.zapier.com/hooks/catch/123/abc",    "trigger": "LEAD_CREATED"  }'
{
  "id": "sub_123"
}
{
  "success": false,
  "message": "invalid_token",
  "error": {
    "status": 401,
    "message": "invalid_token"
  }
}
{
  "success": false,
  "message": "Oops! Something went wrong",
  "error": {
    "status": 500,
    "message": "Oops! Something went wrong"
  }
}

Get Recent Leads GET

Retrieve the 5 most recent leads for providing sample data in the Zap Editor. Returns formatted lead data including contact information and status.

Unsubscribe from Webhook DELETE

Remove an existing webhook subscription. Deletes the webhook URL and trigger configuration to stop automatic notifications.