Leads

Events that fire when Whippy detects a new lead.

Events

Event	When it fires
`lead.new`	A new inbound lead is detected (contact, conversation, and inbound message).

Examples

Each example is the full POST body Whippy sends, including the envelope fields data, api_version, event, created_at, and request_id.

`lead.new`

A new inbound lead is detected (contact, conversation, and inbound message).

{
  "data": {
    "contact": {
      "id": "db737fac-9b54-48ba-9fdc-7db30f907fab",
      "name": "Bruce Wayne",
      "email": "[email protected]",
      "notes": [],
      "phone": "+14244023950",
      "state": "open",
      "blocked": false,
      "last_name": "Wayne",
      "created_at": "2023-09-08T13:55:10.321386Z",
      "first_name": "Bruce",
      "updated_at": "2023-09-08T13:55:10.321386Z",
      "contact_tags": [],
      "communication_preferences": []
    },
    "conversation": {
      "id": "81f291d7-3693-4100-96f1-9957faceebfe",
      "status": "open",
      "language": "en",
      "channel_id": "029f876c-e60f-454b-8e51-4c38f0484140",
      "contact_id": "db737fac-9b54-48ba-9fdc-7db30f907fab",
      "created_at": "2023-09-08T13:55:10.584156Z",
      "updated_at": "2023-09-25T12:35:06.836746Z",
      "channel_type": "phone",
      "unread_count": 3,
      "assigned_team_id": null,
      "assigned_user_id": 2,
      "contact_language": null,
      "last_message_date": "2023-09-25T12:35:06.864042Z"
    },
    "inbound_message": {
      "id": "9fa49dda-ef4e-4992-a44d-1720365d59c2",
      "to": "+14244023933",
      "body": "Hello from the Moon!",
      "from": "+14244023950",
      "step_id": null,
      "language": null,
      "direction": "INBOUND",
      "channel_id": "029f876c-e60f-454b-8e51-4c38f0484140",
      "contact_id": "db737fac-9b54-48ba-9fdc-7db30f907fab",
      "created_at": "2023-09-25T12:35:25.703841Z",
      "updated_at": "2023-09-25T12:35:25.703841Z",
      "attachments": [],
      "campaign_id": null,
      "sequence_id": null,
      "conversation_id": "81f291d7-3693-4100-96f1-9957faceebfe",
      "delivery_status": "webhook_delivered",
      "step_contact_id": null,
      "translated_body": null,
      "campaign_contact_id": null,
      "translation_language": null
    }
  },
  "api_version": "v1",
  "event": "lead.new",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "2962ff56-af7e-5b97-aca4-0094ec56a887"
}