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 - EMAIL_SENT

Below is a sample payload for "Email Sent" webhook and its corresponding field descriptions.
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 2025-06-13 07:24:11
Previous
Sample Payload - LEAD_MARKED_AS_INTERESTED
Next
Add a new webhook
Built with