---
title: "Lead Received"
method: POST
path: "leadReceived"
tags: ["Webhooks Events"]
---

# Lead Received

`POST leadReceived` (webhook)

This event is triggered when a Lead is added in Partoo Database.

The event payload contains the event type and the lead contents.

## Payload

- object
  - `type` 'lead_received'
  - `payload` LeadWebhook
    - `id` integer: The identifier for the webhook configuration.
    - `source` string: The source of the lead, how we retrieved it.
    - `created_at` string: An ISO 8601 date-time string representing the webhook creation date.
    - `conversation_id` integer: The identifier of the conversation that generated the lead
    - `channel` 'Google' | 'Facebook' | 'Instagram' | 'SMS' | 'Whatsapp' | 'Custom' | 'Livechat': The channel from which the lead was collected
    - `chatbot_id` integer: The identifier of the chatbot that collected the lead
    - `chatbot_name` string: Name of the chatbot that collected the lead
    - `business_name` string: Name of the business related to the lead
    - `store_code` string: Store code of the business related to the lead
    - `values` LeadItem[]
      - `id` integer
      - `type` 'TEXT' | 'NUMBER' | 'EMAIL' | 'PHONE_NUMBER' | 'BOOLEAN' | 'OPT_IN': The lead field type. `OPT-IN` type is a `BOOLEAN` type
      - `name` string: name of the field collected
      - `value` string: value of the field corresponding to the lead

## Acknowledgement `200`

Return a 200 status to indicate that the event was properly received

## Other responses

- `500`: An error in range 500-599 will trigger a retry from webhook delivery system, up to 5 times, with an exponential backout. > ⚠️ You may have to deal with events not received in order

---

[API](https://skmtc.dev/partoo/apis/partoo-rest-api.md) - [All operations](https://skmtc.dev/partoo/apis/partoo-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/partoo/apis/partoo-rest-api/revisions/dcb8190f5a29?raw)