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 - Unibox Email Sent

Below is a sample payload for the "Unibox Email Sent" (UNIBOX_EMAIL_SENT) webhook and its corresponding field descriptions.
This event is triggered whenever an email is sent from the Unibox: a manual reply or newly composed email, a scheduled message (the event fires when it is actually sent, not when it is scheduled), an AI-triggered reply, or an automated follow-up. Forwarded messages do not trigger this event.
FieldDescription
webhook_idUnique identifier for this webhook event.
webhook_nameName of the webhook.
webhook_eventType of event that triggered the webhook (UNIBOX_EMAIL_SENT).
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 that sent the email.
sent_viaHow the email was sent from the Unibox: MANUAL_REPLY (reply in an existing thread, including scheduled replies at send time), MANUAL_COMPOSE (newly composed email), AI_REPLY (auto-triggered AI reply), or AUTO_FOLLOW_UP (automated follow-up).
is_forwarded0 — forwarded messages do not trigger this event.
source_thread_idThread ID from the email provider.
source_message_idMessage ID from the email provider.
thread_idInternal PlusVibe thread ID.
sourceINTERNAL — the message was sent from within PlusVibe.
sub_camp_idSubsequence campaign ID, if applicable.
directionOUT — an email sent to the lead.
snippetPlain-text preview of the message body.
subjectEmail subject line.
fromFull From header — the PlusVibe email account that sent the email.
from_emailEmail address of the PlusVibe account that sent the email.
toFull To header — the lead (recipient).
ccCC recipients, if any.
message_idMessage-ID header value of the sent email.
referencesReferences header linking the message to its thread.
reply_toMessage-ID of the message being replied to.
lead_idID of the lead.
campaign_idID of the campaign.
organization_idID of the organization.
bodyHTML content of the message.
text_bodyPlain-text content of the message.
is_read1 — sent messages are marked as read.
statusCurrent status of the lead (e.g. ACTIVE).
labelLabel applied to the lead (e.g. INTERESTED).
sentimentDetected sentiment of the lead's last reply (e.g. POSITIVE).
emailLead's email address.
first_nameLead's first name.
last_nameLead's last name.
company_nameLead's company name.
company_websiteLead's company website URL.
job_titleLead's job title.
phone_numberLead's phone number.
address_lineLead's street address.
cityLead's city.
stateLead's state.
countryLead's country.
country_codeISO country code.
linkedin_person_urlLead's LinkedIn profile URL.
linkedin_company_urlLead's company LinkedIn URL.
email_account_nameEmail address of the PlusVibe account that sent the email.
sender_first_nameFirst name configured on the sending email account.
sender_last_nameLast name configured on the sending email account.
stepCurrent numeric step of the campaign sequence.
variationA/B test variation label (e.g. A, B).
camp_tag_idsArray of tag IDs applied to the campaign.
is_completed1 if the campaign sequence is complete for this lead, 0 otherwise.
custom_*Workspace custom fields of the lead (e.g. custom_company_size), included as-is.
created_atISO timestamp when the lead record was created.
modified_atISO timestamp when the lead record was last modified.
Modified at 2026-07-24 03:30:15
Previous
Webhooks - Payload - Bounced Email
Next
Workspace Deep Link Parameter
Built with