To ensure that your API integration with Zapier is well-documented and meets the requirements outlined in the email, here’s a structured approach to creating comprehensive API documentation.
Overview
Purpose: This documentation provides clear instructions on how to use the API endpoints for integration with Zapier
Endpoints Covered:
/webhook/verify-token/webhook/leads/webhook/jobs?isJob=true
API Endpoints
Verify Token Endpoint
Endpoint: `
/webhook/verify-token`Method: `
POST`Headers:
`token`: The authentication token required for the request.
Response
Success: Returns a JSON object indicating the token is valid.
Error: Returns an error message if the token is invalid.
Leads Endpoint
Endpoint: `
/webhook/leads`Method:
POSTHeaders:
`token`: The authentication token required for the request.Request Body
Required fields: 'firstName', 'email', 'phone', 'date', 'pickup', 'dropoff', 'source'
Example Payload:
Response:
Success: Returns a confirmation message with job details.
Error: Returns an error message if required fields are missing or invalid.
Jobs Endpoint
Endpoint: `
/webhook/jobs?Job=true`Method:
POSTHeaders:
`token`: The authentication token required for the request.Request Body
Required fields: 'firstName', 'email', 'phone', 'date', 'pickup', 'dropoff', 'source', 'time slot', 'booking notes'
Example Payload:
Authentication
Token: Each request must include a valid token in the headers to authenticate the user. This token should be securely generated and managed.