Overview

This API reference is specifically for the Sophiie Zapier App integration, available on the Zapier marketplace. Use these endpoints to connect Sophiie with Zapier, enabling automated workflows and triggers between Sophiie and other Zapier-supported applications.

Base URLs

• Production: https://webhooks.sophiie.ai
• Development: https://webhooks.dev.sophiie.ai

Authentication

All API endpoints require Bearer token authentication. Include your access token in the Authorization header:

Authorization: Bearer <YOUR_ACCESS_TOKEN>

HTTP Methods

The Sophiie API follows REST conventions and uses standard HTTP methods:

GET

GET methods are used for retrieving data. Query parameters can be used for filtering when supported.

curl "https://webhooks.sophiie.ai/api/webhooks/zapier/leads" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"

POST

POST methods are used for creating new resources. Data is passed as application/json in the request body.

curl -X POST "https://webhooks.sophiie.ai/api/webhooks/zapier/subscribe" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"hookUrl": "https://hooks.zapier.com/hooks/catch/123/abc", "trigger": "LEAD_CREATED"}'

DELETE

DELETE methods are used for removing resources.

curl -X DELETE "https://webhooks.sophiie.ai/api/webhooks/zapier/unsubscribe" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"hookUrl": "12345", "trigger": "LEAD_CREATED"}'

Response Format

All API responses are returned as JSON. Successful responses include the requested data, while error responses follow this structure:

{
  "success": false,
  "message": "Error description",
  "error": {
    "status": 401,
    "message": "invalid_token"
  }
}

Available Resources

The Sophiie API provides endpoints for:

• Leads: Retrieve recent leads with contact information and status
• Appointments: Access appointment data including attendees, schedule, and lead information
• Inquiries: Get inquiry data with key points, source information, and lead details
• Webhooks: Subscribe and unsubscribe from webhook notifications
• User: Retrieve current user information