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 - Campaign Emails Sent

Below is a sample payload for the "Campaign Emails Sent" webhook and its corresponding field descriptions.
This event is triggered whenever a campaign email is sent (an email sent automatically as part of a campaign sequence). For historical reasons the webhook event name is EMAIL_SENT - not to be confused with UNIBOX_EMAIL_SENT, which covers emails sent from the Unibox.
FieldDescription
webhook_idUnique identifier for this webhook event.
webhook_nameName of the webhook.
webhook_eventEvent type that triggered the webhook (EMAIL_SENT).
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).
sent_email_idID of the newly-created “sent email” record.
email_account_nameEmail address of the PlusVibe account that sent the message.
lead_emailEmail address of the lead (recipient).
lead_idID of the lead.
campaign_idID of the campaign.
email_account_idID of the PlusVibe email account that sent the email.
organization_idID of the organization.
workspace_idID of the workspace.
current_stepNumeric campaign step at which this email was sent.
sent_onISO timestamp when the email was sent.
variationA/B test variation label associated with this send (e.g. A, B).
message_idCanonical message-ID header value for the sent email.
subjectSubject line of the sent email.
bodyBody content of the sent email.
is_text1 if body is plain-text, 0 if HTML.
_idSame value as lead_id; present for legacy compatibility.
is_completed1 if the campaign step is complete after sending, 0 otherwise.
created_atISO timestamp when this lead record was created.
modified_atISO timestamp when this record was last modified.
statusCurrent status of the send (COMPLETED, etc.).
labelCurrent label applied to the lead (blank if none).
sender_first_nameFirst name of the PlusVibe sender who sent the email.
sender_last_nameLast name of the PlusVibe sender who sent the email.
emailDuplicate of lead_email (kept for legacy reasons).
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.
{
"webhook_id": "6842c5e4c7fc8e4cb5f1c964",
"webhook_name": "test",
"webhook_event": "EMAIL_SENT",
"campaign_name": "Campaign Name",
"workspace_name": "Kurt's Workspace",
"camp_id": "683ea48fc9eb23b0af3dc705",
"parent_lead_id": "684bad3a1bc0b816569675d5",
"sent_email_id": "684bad695817ad0063bda88b",
"email_account_name": "yaro@plusvibeteam.com",
"lead_email": "kurt@plusvibe.ai",
"lead_id": "684bad3a1bc0b816569675d5",
"campaign_id": "683ea48fc9eb23b0af3dc705",
"email_account_id": "68498d9cd610268cc770e102",
"organization_id": "65099a0dd96fae8ab61130bf",
"workspace_id": "65099a0dd96fae8ab61130c0",
"current_step": 1,
"sent_on": "2025-06-13T04:47:37.084+00:00",
"variation": "A",
"message_id": "<fda2cb9f-d142-c364-a166-601d0d64b33e@plusvibeteam.com>",
"subject": "This is the campaign email subject",
"body": "This is the campaign email body",
"is_text": 1,
"_id": "684bad3a1bc0b816569675d5",
"is_completed": 1,
"created_at": "2025-06-13T04:46:50.426Z",
"modified_at": "2025-06-13T04:47:37.199Z",
"status": "COMPLETED",
"is_email_verified": -1,
"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": ""
}
Modified at 2026-07-24 03:30:15
Previous
Webhooks - Payload - Lead Marked As Label
Next
Webhooks - Payload - Bounced Email
Built with