1. Getting Started
Plusvibe.ai API Documentation
  • Getting Started
    • Getting Started
    • Webhooks - Overview
    • Webhooks - Payload - Email Replies
    • Webhooks - Payload - Lead Marked As Label
    • Webhooks - Payload - Campaign Emails Sent
    • Webhooks - Payload - Bounced Email
    • Webhooks - Payload - Unibox Email Sent
    • Workspace Deep Link Parameter
    • Email Infra Provider Guide
  • User API Endpoints
    • Workspace
      • Get workspaces
      • Add a new workspace
      • Copy workspace settings
    • Campaign
      • Create a new campaign
      • Create a new subsequence
      • List campaigns (deprecated)
      • List all campaigns
      • Get campaign name
      • Get campaign status
      • Get campaign email accounts
      • Get campaign emails
      • Get campaign variation stats
      • Set campaign name
      • Set campaign Schedules (deprecated)
      • Activate campaign
      • Pause campaign
      • Update Campaign
      • Delete or archive a campaign
    • Lead
      • Add leads to a campaign
      • Add leads to a subsequence campaign
      • Get or search for lead
      • Delete leads from a campaign
      • Lead Variable/Label Update or Add
      • Fetch workspace leads
      • Update the status of a lead
      • Get lead counts by status
    • 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 (Workspace-Level)
      • Bulk Add SMTP Accounts
      • Bulk Update Email Accounts
      • Bulk Update Email Account Warmup Status
      • Bulk Assign/Remove Tags from Email Accounts
      • Bulk reconnect email accounts
      • Get email account stats for a date range
    • Analytics
      • Get campaign summary
      • Get campaign count (deprecated)
      • Get campaign stats
      • Get all campaigns statistics
    • Unibox
      • Get emails
      • Get emails in Others folder
      • Get count of unread emails
      • Reply to an email
      • Forward an existing email
      • Compose New Email
      • Mark Email Read
      • Save Email as Draft
      • Delete an Entire Email Thread
      • Delete a Single Email Message
    • Blocklist
      • Get entries in the blocklist
      • Adds entries to the blocklist
      • Delete entries in the blocklist
    • Webhook
      • Add a new webhook
      • List webhooks
      • Delete webhook(s)
    • Tags
      • List Tags
      • Create a New Tag
      • Update an Existing Tag
      • Delete Multiple Tags
    • Client Access
      • Create client
      • Edit client
      • Update client status
      • Delete client
      • List clients
    • Email Placement Test
      • Parent Recurring Test
        • Create a new parent test (recurring test)
        • Update a parent test
        • List all parent tests
        • Get parent test details
        • Delete parent test(s)
        • Duplicate a parent test
      • Child (Test Run) Test
        • List child (Test Run) tests
        • Get child test details
      • Results & Analytics
        • Get test summary
        • Get detailed test statistics
        • Get test result for a sender account
      • Get recipient providers
    • Schemas
      • ScheduleV2
      • SequenceStep
      • Campaign
      • Variation
      • EmailAccountId
      • WarmupStatus
      • BulkUpdateWarmupRequest
      • TagAction
      • BulkTagAssignmentRequest
      • ObjectId
      • HexColor
      • CreateTagRequest
      • UpdateTagRequest
      • DeleteTagsRequest
      • DeleteCampaignRequest
      • BulkReconnectRequest
      • SuccessResponse
      • ErrorResponse
      • ClientWorkspacePermission
      • CreateClientRequest
      • CreateClientResponse
      • UpdateClientRequest
      • ClientListItem
      • PatchClientStatusRequest
      • GenericSuccessResponse
      • ParentTest
      • ParentTestDetail
      • ChildTest
      • ChildTestDetail
      • VariationStepStats
      • VariationStats
      • CopyWorkspaceRequest
      • ResourceType
      • CopyWorkspaceResponse
      • EmailStatsResponse
      • EmailStatsHeader
      • EmailStatsChartPoint
      • ValidationErrorResponse
      • CheckSuccess
      • AuthFailure
  • For Email Infra Provider
    • Email Infra Provider Guide
    • List workspaces
      POST
    • List all email accounts in the workspace
      GET
    • Check if an email exists in another workspace
      GET
    • Initiate Google OAuth login flow
      POST
    • Initiate Microsoft OAuth login flow
      POST
    • Bulk Add SMTP Accounts (via Username and Password)
      POST
    • Schemas
      • AuthFailure
      • CheckSuccess
      • ErrorResponse
  1. Getting Started

Webhooks - Payload - Email Replies

Below is a sample payload for "All Email Replies", "All First Replies", "All Positive Replies" webhook and its corresponding field descriptions.
FieldDescription
webhook_idUnique identifier for this webhook event.
webhook_nameName of the webhook.
webhook_eventType of event that triggered the webhook (e.g. FIRST_EMAIL_REPLIES, ALL_EMAIL_REPLIES, ALL_POSITIVE_REPLIES).
campaign_nameName of the campaign.
workspace_nameName of the workspace.
camp_idLegacy campaign ID (use campaign_id instead).
parent_lead_idRelevant only for leads in subsequence campaigns.
org_idID of the organization.
workspace_idID of the workspace.
email_account_idID of the PlusVibe email account involved.
source_thread_idThread ID from the email provider.
source_message_idOriginal message ID from the email provider.
thread_idInternal PlusVibe thread ID.
source_label_idsArray of provider label IDs (e.g. INBOX).
subjectEmail subject line.
fromFull From header — the lead (prospect) who replied.
from_emailEmail address of the lead who replied.
toFull To header — the email account connected to PlusVibe that received the email.
lead_idID of the lead.
sub_camp_idSubsequence campaign ID, if applicable.
directionIN = lead replying, OUT = email sent to a lead.
snippetPlain-text preview of the message body.
bodyHTML content of the message.
text_bodyPlain-text content of the message.
is_read1 if the message has been read; 0 otherwise.
statusCurrent status of the message (e.g. REPLIED).
modified_atISO timestamp when this record was last modified.
actual_replied_fromThe actual email address the lead used to reply from.
last_email_idID of the most recent message in this thread. If you want to use the Reply Email endpoint, this would be the id for 'reply_to_id'
message_idThe RFC-822 message Id.
referencesRFC-822 References header value.
reply_toRFC-822 Reply-To header value.
ccFull CC header, if any.
to_emailEmail address of the the email account connected to PlusVibe that received the email.
_idSame as lead_id; present for legacy reasons.
organization_idID of the organization (duplicate of org_id).
campaign_idID of the campaign.
created_atISO timestamp when this record was created.
labelLabel assigned to the lead (e.g. INTERESTED).
is_email_verified1 if lead’s email passed verification; 0 if failed; -1 if unknown.
email_account_nameEmail address of the PlusVibe account.
sender_first_nameFirst name of the sender.
sender_last_nameLast name of the sender.
emailLead’s email address.
first_nameLead’s first name.
last_nameLead’s last name.
address_lineLead’s street address.
cityLead’s city.
stateLead’s state or province.
countryLead’s country.
country_codeISO country code.
phone_numberLead’s phone number.
job_titleLead’s job title.
departmentLead’s department.
company_nameLead’s company name.
company_websiteLead’s company website URL.
industryLead’s industry.
linkedin_person_urlLead’s LinkedIn profile URL.
linkedin_company_urlLead’s company LinkedIn URL.
sentimentDetected sentiment of the lead’s reply (e.g. POSITIVE, NEUTRAL, NEGATIVE).
stepNumeric campaign step at which this email was sent.
variationA/B test variation label (e.g. A, B).
{
"webhook_id": "6842c5e4c7fc8e4cb5f1c964",
"webhook_name": "test webhook",
"webhook_event": "ALL_EMAIL_REPLIES",
"campaign_name": "Campaign Name",
"workspace_name": "Kurt's Workspace",
"camp_id": "683ea48fc9eb23b0af3dc705",
"parent_lead_id": "684bad3a1bc0b816569675d5",
"org_id": "65099a0dd96fae8ab61130bf",
"workspace_id": "65099a0dd96fae8ab61130c0",
"email_account_id": "68498d9cd610268cc770e102",
"source_thread_id": "AAQkADQ0MjRkNDRlLWYxYzUtNGM5Ni1hZWRkLWY1OGU5N2ZlYTBlNQAQAJ4wJs1nhZlNk6YJcm7E9vM=",
"source_message_id": "<CACk81oWMxm+S2QadZuhuY1JZ6cT6wcuAdtjY5LEJH-PqCfc6tg@mail.gmail.com>",
"thread_id": "684baeaab28c872fd921be66",
"source_label_ids": [
"INBOX"
],
"subject": "Re: This is the campaign email subject",
"from": "Kurt Wong <kurt@plusvibe.ai>",
"from_email": "kurt@plusvibe.ai",
"to": "Yaro Y <yaro@plusvibeteam.com>",
"lead_id": "684bad3a1bc0b816569675d5",
"sub_camp_id": null,
"direction": "IN",
"snippet": "hey, please tell me more about it\n\nOn Fri, Jun 13, 2025 at 12:47 PM Yaro Y <yaro@plusvibeteam.com> wrote:\n\n> This is the campaign email body\n>\n",
"body": "<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> wrote:\n\n> This is the campaign email body\n>\n",
"is_read": 0,
"status": "REPLIED",
"modified_at": "2025-06-13T04:47:37.199Z",
"actual_replied_from": "kurt@plusvibe.ai",
"last_email_id": "684baeaa1b6bfcf3051ef456",
"message_id": "<CACk81oWMxm+S2QadZuhuY1JZ6cT6wcuAdtjY5LEJH-PqCfc6tg@mail.gmail.com>",
"references": "<fda2cb9f-d142-c364-a166-601d0d64b33e@plusvibeteam.com>",
"reply_to": "<fda2cb9f-d142-c364-a166-601d0d64b33e@plusvibeteam.com>",
"cc": null,
"to_email": "yaro@plusvibeteam.com",
"_id": "684bad3a1bc0b816569675d5",
"organization_id": "65099a0dd96fae8ab61130bf",
"campaign_id": "683ea48fc9eb23b0af3dc705",
"created_at": "2025-06-13T04:46:50.426Z",
"label": "INTERESTED",
"is_email_verified": -1,
"email_account_name": "yaro@plusvibeteam.com",
"sender_first_name": "Yaro Y",
"sender_last_name": "",
"email": "kurt@plusvibe.ai",
"first_name": "John",
"last_name": "Doe",
"address_line": "",
"city": "",
"state": "",
"country": "",
"country_code": "",
"phone_number": "",
"job_title": "",
"department": "",
"company_name": "",
"company_website": "",
"industry": "",
"linkedin_person_url": "",
"linkedin_company_url": "",
"sentiment": "POSITIVE",
"step": 1,
"variation": "A"
}
Modified at 2026-07-24 02:28:47
Previous
Webhooks - Overview
Next
Webhooks - Payload - Lead Marked As Label
Built with