API Documentation for Zapier Integration
This document provides an overview of the API endpoints used for the Zapier integration. Each endpoint includes its purpose, request method, URL, required parameters, and example responses.
Authentication
check_api_key
Validates the API key provided in the request headers.
Header:
maximiz_api_key (string) - API key required for authentication.
Responses:
200 OK: Valid API key.
401 Unauthorized: Missing or invalid API key.
404 Not Found: Domain not found.
Endpoints
1. Add Zapier Integration
Method: GET
Description: Adds a new integration for the domain if credentials are not already present.
Headers:
maximiz_api_key (string): Required for authentication.
Response:
200 OK: Integration successfully added.
400 Bad Request: Integration creation failed.
2. Subscribe to Zapier Webhook
Method: POST
Description: Creates a new data synchronization between Zapier and the domain.
Headers:
maximiz_api_key (string): Required for authentication.
Body (JSON):
{
"leadsType": "string", // Type of leads to synchronize.
"hookUrl": "string", // URL for the webhook.
"listName": "string" // Name of the list for synchronization.
}
Response:
201 Created: Synchronization successfully created.
400 Bad Request: Failed to create synchronization.
3. Unsubscribe from Zapier Webhook
Method: DELETE
Description: Deletes an existing synchronization based on the webhook URL.
Headers:
maximiz_api_key (string): Required for authentication.
Body (JSON):
{
"hookUrl": "string" // URL of the webhook to unsubscribe.
}
Response:
200 OK: Synchronization successfully deleted.
400 Bad Request: Failed to delete synchronization.
4. Retrieve Leads for Zapier
Method: GET
Description: Retrieves data about recent leads.
Headers:
maximiz_api_key (string): Required for authentication.
Response:
200 OK: A list of up to three leads with detailed information:
[
{
"id": "123",
"first_name": "John",
"last_name": "Doe",
"mobile_phone": "123-456-7890",
"company_name": "Example Inc.",
"job_title": "Manager",
"gender": "male",
"income_range": "50k-70k",
"personal_city": "New York",
"personal_state": "NY",
"personal_zip": "10001",
"homeowner": true
}
]
Notes
Ensure that all requests include the maximiz_api_key header for authentication.
For POST and DELETE requests, ensure the body is formatted correctly as JSON.
Response status codes indicate the success or failure of the request. Use them to debug issues during integration.
For further assistance, contact support at login@maximiz.ai.