Skip to main content

API Integration Guide

Updated over a month ago

This document provides a structured approach to integrating with the API. It includes endpoint details, request formats, authentication methods, and expected responses.


Endpoints Overview

Endpoint

Method

Description

/webhook/verify-token

POST

Validates the authentication token.

/webhook/leads

POST

Submits lead information.

/webhook/jobs?isJob=true

POST

Creates a job with detailed booking information.


1.Verify Token Endpoint

Endpoint: /webhook/verify-token

Method: POST

Headers:

  • token: Required authentication token.

Response

Success: Token validation confirmation. ❌ Error: Invalid token response.


2. Leads Endpoint

Endpoint: /webhook/leads

Method: POST

Headers:

  • token: Required authentication token.

Request Body (Required Fields)

Response

Success: Returns a confirmation message with job details. ❌ Error: Missing or invalid fields.


3. Jobs Endpoint

Endpoint: /webhook/jobs?isJob=true

Method: POST

Headers:

  • token: Required authentication token.

Request Body (Required Fields)

Response

Success: Job created successfully. ❌ Error: Missing or invalid fields.


Authentication & Security

  • Each request must include a valid token in the headers.

  • Tokens should be securely generated and managed to prevent unauthorized access.

  • API responses are returned in JSON format.


Best Practices

✔ Always ensure request payloads contain all required fields.

✔ Handle API responses correctly, checking for success and error messages.

✔ Securely store and manage authentication tokens.

✔ Use structured error handling for seamless integration.

📌 For further assistance, refer to the API support team or documentation updates.

Did this answer your question?