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

Add a new webhook

POST
https://api.plusvibe.ai/api/v1/hook/add
Webhook
Add a webhook to PlusVibe.ai for specified events, campaigns, and conditions.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.plusvibe.ai/api/v1/hook/add' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workspace_id": "65099a0dd96fae8ab61130c0",
  "name": "My Webhook",
  "url": "https://example.com/webhook-handler",
  "camp_ids": [
    "675926845560f5bb420dca12",
    "670b156d989304cbe0949b09"
  ],
  "event_types": [
    "LEAD_MARKED_AS_INTERESTED",
    "ALL_EMAIL_REPLIES"
  ],
  "is_slack": null,
  "secret": "",
  "ignore_ooo": 1,
  "ignore_automatic": 0
}'
Response Response Example
{
    "status": "success",
    "_id": "675fb344e5c1f6922e9f9eba"
}

Request

Header Params
x-api-key
string 
required
Your PlusVibe.ai account's API Key
Default:
Example:
your-api-key
Body Params application/json
workspace_id
string 
required
The ID of the workspace to associate the webhook with.
name
string 
required
A name for the webhook.
url
string 
required
The URL to send webhook events to.
camp_ids
array[string]
required
List of campaign IDs to trigger the webhook for. Use "ALL" to trigger for all campaigns.
event_types
array[string]
required
A list of event types to trigger the webhook. Examples include:
LEAD_MARKED_AS_INTERESTED: Triggered when a lead is marked as "interested".
Custom label names (e.g., LEAD_MARKED_AS_X where X is a custom label).
ALL_EMAIL_REPLIES: Triggered for all email replies.
is_slack
null 
required
Indicates if the webhook is for Slack integration (1 for true, 0 for false).
secret
string 
required
Optional secret key for verifying webhook payloads.
ignore_ooo
integer 
required
Relevant for ALL_EMAIL_REPLIES events. When set to 1, ignores out-of-office replies.
ignore_automatic
integer 
required
Relevant for ALL_EMAIL_REPLIES events. When set to 1, ignores automatic replies.
Examples

Responses

🟢200OK
application/json
Webhook added successfully.
Body
status
string 
optional
The status of the operation.
Example:
success
_id
string 
optional
The unique ID of the created webhook.
Example:
675fb344e5c1f6922e9f9eba
Modified at 2025-05-24 07:16:13
Previous
Sample Payload - EMAIL_SENT
Next
List webhooks
Built with