Skip to content
English
  • There are no suggestions because the search field is empty.

Webhooks: Understanding Lead Details & Status

How It Works

This guide will walk you through what’s included in the webhook, the different statuses you may see, and how to interpret the data.

When a lead’s status changes, Meera sends a webhook callback to the URL you’ve configured.

  • Webhook URL (Example):
    https://yourdomain.com/api/webhooks/meera

  • Authorization:
    [your endpoint's authentication scheme if applicable]

  • Content Type:
    application/json

These settings are typically used by your development or IT team to connect Meera to your internal systems.

What’s in the Webhook?

Meera’s webhook includes a structured JSON payload that contains the following:

Field Description
status Confirms the webhook was sent successfully (should be true)
message Usually displays success
pushbackUrl The receiving URL that we've called
 lead_status The current status of the lead within the Campaign (see below)
lead_details The current details of the lead (see below)

Example Payload

{
  "status": true,
  "message": "Success",
  "pushbackUrl": "https://webhooks.your_crm.com/api/meera",
  "lead_status": "Responded",
  "lead_details": {
      "current_status": "open",
      "lead_id": 12142842,
      "posted_date": "2024-02-14",
      "first_name": "Test",
      "last_name": "Lastname",
      "external_caller_id": "",
      "email": "test@test.com",
      "full_name": "Test Lastname",
      "user_timezone": "America/New_York",
      "mobile_number": "+14405550873",
      "rep_phone": null,
      "ps_id": "",
      "external_system_id": "test-id",
      "campaign_name": "WCT - New Leads (General)",
      "campaign_timezone": "America/Toronto",
      "campaign_id": 1234,
      "message_status": "delivered",
      "send_welcome_msg": "Yes",
      "dnd_status": "No",
      "dnd_reason": "",
      "soft_close": "No",
      "soft_close_reason": "",
      "responded": "Yes",
      "responded_date_time": "2024-11-16 10:30:59 AM EST",
      "confirm_rsvp": "",
      "rsvp_session": "",
      "scheduled": "No",
      "scheduled_date_time": "",
      "call_attempt": 0,
      "called": "No",
      "call_status": "notdone",
      "called_date_time": "",
      "transfered": "No",
      "transfered_date_time": "",
      "all_converted": "No",
      "all_converted_date_time": "",
      "converted_inbound": "No",
      "converted_outbound": "No",
      "total_call_duration": 137,
      "representative_call_duration": null
  },
  "lead_info": {
      "email": "test@test.com"
  }
}

Lead Details

The lead_details object contains a comprehensive view of the lead, including contact info, campaign info, status updates, and call activity.

Key Fields:

  • Lead Identity:

    lead_id, first_name, last_name, full_name, email, mobile_number

  • Campaign Info:

    campaign_name, campaign_id, campaign_timezone, external_system_id

  • Status Details:

    current_status ("open" or "close"), lead_status, message_status

  • Call & Response Activity:

    • responded / responded_date_time

    • called / called_date_time / call_status

    • call_attempt, total_call_duration, representative_call_duration

  • Transfer & Conversion:

    • transfered, transfered_date_time

    • converted_inbound, converted_outbound, all_converted

  • Other Fields:

    • send_welcome_msg (Yes/No)
    • dnd_status, dnd_reason (see more info)
    • soft_close, soft_close_reason (see more info)
    • confirm_rsvp, scheduled, scheduled_date_time
  • Custom Fields:

    The lead_info object includes any custom fields set up for your Campaign.

Lead Status

The lead_status  object details where the lead is within the current Campaign progress.  Below are some common statuses and their meanings.  Each reflects a different point in the lead’s journey:

  • Posted: The lead has been successfully inserted into the campaign, but has yet to be processed further.

  • NotDone: Lead has not yet received a message or is already marked as DNC.

  • Undelivered: The SMS message to the lead was not successfully delivered.

  • Delivered: The message(s) were delivered, but no response was received.

  • Responded: Lead has initially responded to the campaign.

  • Scheduled: An appointment is scheduled for the client per the lead's request.

  • CallInitiated: The warm call transfer attempt has just begun.

  • Called: The lead was called, but there was no transfer.

  • Transferred: The call was transferred, but only lasted 30-90 seconds.

  • RepCall30SEC: The call was transferred, but lasted less than 30 seconds.

  • Converted: A warm call transfer was completed and the call lasted over 90 seconds.

  • DNC: Do Not Contact; the lead is not interested in receiving any communications and is fully unsubscribed from all Campaigns.

    Note: If you encounter this DNC status, please refer to the dnd_status and dnd_reason fields within the lead_details object.  Please see below for examples of possible values.  Additionally, you can retrieve full message logs by calling the get_message_log endpoint.

  • LcmLeadClose: Soft Close; the lead is not interested in receiving information regarding this particular Campaign.

    Note: If you encounter this Soft Close status, refer to the soft_close and soft_close_reason fields within the lead_details object.  Please see below for examples of possible values.  Additionally, you can retrieve the message log by calling the get_message_log endpoint.

  • NoRepResponse: The lead requested an appointment, but no representative was available.

  • ClosedAfterFollowup: Maximum # of follow-up attempts have been exhausted, and the lead has been closed.

  • ClosedByClient: The lead was closed by Meera customer's request.

  • BadPhone: The phone number is invalid, a landline, or no longer exists.

Hard DNC Reasons

 

  DNC:Wrong_Number

DNC:Unsubscribe

  DNC:Abuse/Threaten

  DNC:Death

 

Soft Close Reasons

 

Already_A_Customer

Close:Not_Refinancing

Close:Already_Completed

Close:Not_Sure/Undecided

Close:Already_Enrolled

Close:Not_Sure/Undecided:Context:Positive

Close:Already_Spoke_With_Rep

Close:Out_Of_Coverage

Close:Awaiting_Payment

Close:Payment_Done

Close:Cancel

Close:Payment_done

Close:Cancel_Enrollment

Close:Project_Cancel

Close:Chose_Another_Option

Close:Recovered_No_Disorder

Close:Chose_Another_School

Close:Social_Anxiety

Close:Choose_Another_Service

Close:Sold_Assets

Close:Claim_Denied

Close:Sold_House

Close:Claim_Settled

Close:Unqualify

Close:Debt_Settled/Closed

Close:Unqualified

Close:Didnot_Request_Info

Close:Under_Age

Close:Education_Completed

Close:Will_Send

Close:Enquired_For_Family/Friend

Close:Will_Submit_Documents

Close:Enquired_For_Someone_Else

Closed:Already_Purchased/Serviced

Close:Expensive/Out_Of_Budget

Closed:Sold

Close:Expensive/Out_Of_Budget:Context:

Positive

Informative:Awaiting_Payment

Close:Filed_for_bankruptcy

Informative:Campaign_hours_doesnt_work

Close:Have_A_Lawyer

Informative:Event_Attended_Already

Close:Have_Insurance

Informative:Frustrated_User

Close:Have_Required_Info

Informative:Negative_Experience

Close:Hearing_Issues/Deaf/Mute

Informative:Never_Ordered_Previously

Close:Interested_For_Future

Informative:No_Current_VA_Claims

Close:Interested_For_Future:Context:Positive

Informative:Scam

Close:Inperson_Appointment

Informative:Scam_RSVP

Close:Lead_Close

Negative:Background_Check/Drug_Screening/Insurance/Immunization

Close:Lead_Will_Call_Back

Negative:Cancel

Close:Lead_Will_Call_Back:Context:Positive

Negative:High_School_Diploma/Equivalent

Close:Loan_Not_Required

Negative:Refusal_To_Provide

Close:Loan_Received

Query:Gas_Grocery_Bills

Close:Location_Issue

Query:How_You_Got_My_Info

Close:Moving/Relocated

Query:How_You_Got_My_Info_RSVP

Close:No_Accident

Query:Joining_Local_Troop

Close:No_Debt

Query:Location_Query

Close:No_Help_Needed

Query:Negative_Reviews

Close:No_Membership

Query:What

Close:Non_HomeOwner

Query:Who

Close:Not_Interested

Unavailable:Busy

Close:Not_Interested:Context:Positive

Unavailable:Negative

Close:Not_Interested_In_Program

Unavailable:No


 Note: The list of soft close statuses provided above may not be fully exhaustive and is subject to updates as new scenarios arise across different campaign use cases.

Further Reading

To better understand how these lead status updates are sent through webhooks, refer to our article on the full webhook flow: Understanding and Setting up Webhooks

Still Need Help?

If you need assistance setting up your webhook URL, decoding the payload, or understanding how to map this data into your system, our team is happy to help.

Reach out at help@meera.ai