Leads

The API exposes three main capabilities:

1. Creating Leads

External systems submit new leads using a structured payload containing customer information, appointment preferences, and service request details.

Typical use cases include:

• A website “Request Service” form

• A mobile app allowing users to request service

• A partner platform sending leads into your operations system

Once created, the API returns a unique lead identifier that can be stored and referenced in your system.

2. Retrieving Lead Details

Systems that need to display or track existing leads can request detailed information by providing the lead’s unique identifier.

This is useful for:

• CRM or call center applications that allow staff to review customer data

• Reporting dashboards that show lead details

• Automated workflows that make decisions based on status or content of a lead

The detail returned includes the customer profile, service request, appointment preferences, metadata, and the current lead status.

3. Registering Webhooks

A webhook allows your system to receive real-time notifications when important lead events occur.

This is useful when:

• You want to avoid polling the API repeatedly

• You need instant updates for downstream workflows

• You are integrating with marketing automation or CRM systems
  

After registering a webhook URL, your system will receive event-based callbacks from FeildEdge whenever applicable lead-related events take place.