Skip to main content
POST
https://credzu.com/wp-json/credzu/v1
/
get-events
curl -X POST https://credzu.com/wp-json/credzu/v1/get-events \
  -H "Content-Type: application/json" \
  -H "Authorization: Credzu-Key YOUR_API_KEY" \
  -d '{
    "lead_id": 44921
  }'
{
  "success": true,
  "data": [
    {
      "event_name": "lead_received",
      "event_payload": {
        "partner_lead_id": "FBHL-55672"
      },
      "created_at": "2025-01-15 10:30:00"
    },
    {
      "event_name": "client_account_created",
      "event_payload": null,
      "created_at": "2025-01-15 14:22:00"
    },
    {
      "event_name": "credit_scan_completed",
      "event_payload": null,
      "created_at": "2025-01-16 09:15:00"
    },
    {
      "event_name": "contract_signed",
      "event_payload": null,
      "created_at": "2025-01-18 11:45:00"
    },
    {
      "event_name": "escrow_funded",
      "event_payload": null,
      "created_at": "2025-01-18 14:22:00"
    },
    {
      "event_name": "score_update",
      "event_payload": {
        "experian_gain": 21,
        "equifax_gain": 17,
        "transunion_gain": 19,
        "estimated_time_remaining": "45-90 days"
      },
      "created_at": "2025-03-04 10:00:00"
    }
  ]
}

Overview

Returns the complete history of Credzu events associated with a lead. Use this to see all milestones a borrower has passed through.

Request Body

lead_id
integer
required
The Credzu lead ID returned when the lead was created

Response

success
boolean
true if events were retrieved
data
array
Array of event objects, ordered chronologically (oldest first)
curl -X POST https://credzu.com/wp-json/credzu/v1/get-events \
  -H "Content-Type: application/json" \
  -H "Authorization: Credzu-Key YOUR_API_KEY" \
  -d '{
    "lead_id": 44921
  }'
{
  "success": true,
  "data": [
    {
      "event_name": "lead_received",
      "event_payload": {
        "partner_lead_id": "FBHL-55672"
      },
      "created_at": "2025-01-15 10:30:00"
    },
    {
      "event_name": "client_account_created",
      "event_payload": null,
      "created_at": "2025-01-15 14:22:00"
    },
    {
      "event_name": "credit_scan_completed",
      "event_payload": null,
      "created_at": "2025-01-16 09:15:00"
    },
    {
      "event_name": "contract_signed",
      "event_payload": null,
      "created_at": "2025-01-18 11:45:00"
    },
    {
      "event_name": "escrow_funded",
      "event_payload": null,
      "created_at": "2025-01-18 14:22:00"
    },
    {
      "event_name": "score_update",
      "event_payload": {
        "experian_gain": 21,
        "equifax_gain": 17,
        "transunion_gain": 19,
        "estimated_time_remaining": "45-90 days"
      },
      "created_at": "2025-03-04 10:00:00"
    }
  ]
}

Event Types

EventDescription
lead_receivedLead was created in Credzu
client_account_createdBorrower logged in and completed onboarding
credit_scan_completedBorrower completed credit scan
client_engaged_in_chatBorrower sent messages in chat
contract_signedBorrower signed service contract
escrow_fundedBorrower funded escrow account
score_updateCredit score update (includes score gains)
mortgage_readyBorrower meets credit criteria
Use this endpoint to build a timeline view of borrower progress in your CRM or LOS system.