PlusVibe.ai
  1. Webhook
PlusVibe.ai
  • PlusVibe.ai API Documentation
  • Workspace
    • Get workspaces
      GET
    • Add a new workspace
      POST
  • Campaign
    • Create a new campaign
      POST
    • Create a new subsequence
      POST
    • List campaigns (deprecated)
      GET
    • List all campaigns
      GET
    • Get campaign name
      GET
    • Get campaign status
      GET
    • Get campaign email accounts
      GET
    • Get campaign emails
      GET
    • Set campaign name
      POST
    • Set campaign Schedules
      POST
    • Activate campaign
      POST
    • Pause campaign
      POST
  • Lead
    • Add leads to a campaign
      POST
    • Add leads to a subsequence campaign
      POST
    • Get or search for lead
      GET
    • Delete leads from a campaign
      POST
    • Lead Variable/Label Update or Add
      POST
    • Fetch workspace leads
      GET
    • Update the status of a lead
      POST
  • Email Account
    • List all email accounts in the workspace
    • Get email account status
    • Check account vitals
    • Enable Email account warmup
    • Pause Email account warmup
    • Delete Email account
    • Get Warmup Stats (Individual Account)
    • Get Warmup Stats (Workspace-Level)
    • Bulk Add SMTP Accounts
  • Analytics
    • Get campaign summary
    • Get campaign count (deprecated)
    • Get campaign stats
    • Get all campaigns statistics
  • Unibox
    • Get emails
    • Get count of unread emails
    • Reply to an email
    • Forward an existing email
    • Mark email read
  • Blocklist
    • Get entries in the blocklist
    • Adds entries to the blocklist
    • Delete entries in the blocklist
  • Webhook
    • PlusVibe Webhook Overview
    • Sample Payload - FIRST_EMAIL_REPLIES, ALL_EMAIL_REPLIES, ALL_POSITIVE_REPLIES
    • Sample Payload - LEAD_MARKED_AS_INTERESTED
    • Sample Payload - EMAIL_SENT
    • Add a new webhook
      POST
    • List webhooks
      GET
    • Delete webhook(s)
      DELETE
  • Tag
    • List Tags
  • For Email Infra Provider Partner
    • List workspaces
    • Initiate Google OAuth login flow
    • Initiate Microsoft OAuth login flow
    • Bulk Add SMTP Accounts (via Username and Password)
  1. Webhook

Sample Payload - LEAD_MARKED_AS_INTERESTED

Below is a sample payload for "Lead Marked As Interested" webhook and its corresponding field descriptions.
For other label, e.g. "Not Interested", Webhook event would be LEAD_MARKED_AS_NOT_INTERESTED. Note that label Name has to be in all uppercase in webhook_event.
FieldDescription
webhook_idUnique identifier for this webhook event.
webhook_nameName of the webhook.
webhook_eventEvent type that triggered the webhook (e.g. LEAD_MARKED_AS_INTERESTED, LEAD_MARKED_AS_NOT_INTERESTED).
campaign_nameName of the campaign.
workspace_nameName of the workspace.
camp_idLegacy campaign ID (use campaign_id instead).
parent_lead_idLead ID in the parent campaign; relevant only for subsequence campaigns (NULL if not applicable).
_idSame value as lead_id; present for legacy compatibility.
address_lineLead’s street address.
cityLead’s city.
countryLead’s country.
country_codeISO country code.
phone_numberLead’s phone number.
company_nameLead’s company name.
company_websiteLead’s company website URL.
emailLead’s email address.
first_nameLead’s first name.
last_nameLead’s last name.
organization_idID of the organization.
campaign_idID of the campaign.
workspace_idID of the workspace.
current_stepCurrent numeric step of the campaign sequence.
email_account_idID of the PlusVibe email account involved.
created_atISO timestamp when this lead record was created.
modified_atISO timestamp when this record was last modified.
statusLatest email status for this lead (e.g. REPLIED).
labelCurrent label applied to the lead (INTERESTED).
linkedin_person_urlLead’s LinkedIn profile URL.
linkedin_company_urlLead’s company LinkedIn URL.
job_titleLead’s job title.
departmentLead’s department.
industryLead’s industry.
stateLead’s state or province.
actual_replied_fromEmail address the lead actually used to reply from (if applicable).
email_account_nameEmail address of the PlusVibe account associated with this lead.
last_lead_replyHTML body of the most recent INBOUND reply from the lead (not forwarded).
text_bodyPlain-text version of last_lead_reply.
last_lead_reply_subjectSubject line of the lead’s most recent reply.
last_email_idID of the latest email message linked to this lead.
last_thread_idID of the latest email thread linked to this lead.
latest_messageHTML body of the most recent message (INBOUND or OUTBOUND, not forwarded) in the thread.
latest_subjectSubject line of the most recent message in the thread.
lead_idID of the lead (primary key).
is_email_verified1 if the lead’s email passed verification, 0 if failed, -1 if unknown.
sender_first_nameFirst name of the PlusVibe sender who last emailed this lead.
sender_last_nameLast name of the PlusVibe sender who last emailed this lead.
sentimentDetected sentiment of the lead’s latest reply (POSITIVE, NEUTRAL, NEGATIVE).
stepCampaign step at which the lead was marked as interested.
variationA/B test variation label associated with the email that triggered interest (e.g. A, B).
{
"webhook_id": "6842c5e4c7fc8e4cb5f1c964",
"webhook_name": "test webhook",
"webhook_event": "LEAD_MARKED_AS_INTERESTED",
"campaign_name": "Campaign Name",
"workspace_name": "Kurt's Workspace",
"camp_id": "683ea48fc9eb23b0af3dc705",
"parent_lead_id": "NULL",
"_id": "684bad3a1bc0b816569675d5",
"address_line": "",
"city": "",
"country": "",
"country_code": "",
"phone_number": "",
"company_name": "",
"company_website": "",
"email": "kurt@plusvibe.ai",
"first_name": "John",
"last_name": "Doe",
"organization_id": "65099a0dd96fae8ab61130bf",
"campaign_id": "683ea48fc9eb23b0af3dc705",
"workspace_id": "65099a0dd96fae8ab61130c0",
"current_step": 1,
"email_account_id": "68498d9cd610268cc770e102",
"created_at": "2025-06-13T04:46:50.426Z",
"modified_at": "2025-06-13T04:47:37.199Z",
"status": "REPLIED",
"label": "INTERESTED",
"linkedin_person_url": "",
"linkedin_company_url": "",
"job_title": "",
"department": "",
"industry": "",
"state": "",
"mx": "GOOGLE_WORKSPACE",
"actual_replied_from": "kurt@plusvibe.ai",
"hubspot_id": null,
"hubspot_deal_id": null,
"email_account_name": "yaro@plusvibeteam.com",
"last_lead_reply": "<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><div dir="ltr">hey, please tell me more about it</div><br><div class="gmail_quote gmail_quote_container"><div dir="ltr" class="gmail_attr">On Fri, Jun 13, 2025 at 12:47 PM Yaro Y &lt;<a href="mailto:yaro@plusvibeteam.com">yaro@plusvibeteam.com</a>&gt; wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">This is the campaign email body<br>\n</blockquote></div>\n",
"text_body": "hey, please tell me more about it\n\nOn Fri, Jun 13, 2025 at 12:47 PM Yaro Y <yaro@plusvibeteam.com [yaro@plusvibeteam.com]> wrote:\n\n\n> This is the campaign email body",
"last_lead_reply_subject": "Re: This is the campaign email subject",
"last_email_id": "684baeaa1b6bfcf3051ef456",
"last_thread_id": "684baeaab28c872fd921be66",
"latest_message": "<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><div dir="ltr">hey, please tell me more about it</div><br><div class="gmail_quote gmail_quote_container"><div dir="ltr" class="gmail_attr">On Fri, Jun 13, 2025 at 12:47 PM Yaro Y &lt;<a href="mailto:yaro@plusvibeteam.com">yaro@plusvibeteam.com</a>&gt; wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">This is the campaign email body<br>\n</blockquote></div>\n",
"latest_subject": "Re: This is the campaign email subject",
"lead_id": "684bad3a1bc0b816569675d5",
"is_email_verified": -1,
"sender_first_name": "Yaro",
"sender_last_name": "Y",
"sentiment": "POSITIVE",
"step": 1,
"variation": "A"
}
Modified at 2025-06-13 08:22:01
Previous
Sample Payload - FIRST_EMAIL_REPLIES, ALL_EMAIL_REPLIES, ALL_POSITIVE_REPLIES
Next
Sample Payload - EMAIL_SENT
Built with