What is a Webhook?
A webhook is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately. Unlike typical APIs where you need to poll for data frequently, a webhook is only triggered by specific events, sending data automatically.
How Webhooks Work with Pipl.ai
With Pipl.ai, you can use webhooks to connect your cold email campaigns to other systems or applications seamlessly. This integration allows you to automate reactions or actions based on the events that occur within your email campaigns. For instance, if you receive a reply to an email, a webhook can automatically trigger a notification in your CRM system, update lead statuses, or initiate other workflows in connected apps.
Supported Event Types
Pipl.ai currently supports the following event types for webhooks, allowing you to tailor the information flow based on specific campaign activities:
All Email Replies: Triggered when any email receives a reply.
Lead marked as Lead
Lead marked as Interested
Lead marked as Not Interested
Lead marked as Out of Office
Lead marked as Meeting Booked
Lead marked as Meeting Completed
Lead marked as Wrong Person
Lead marked as Closed
JSON Body of the Events
The JSON body sent via webhooks will contain detailed information related to each event. This includes identifiers like the lead's email address, the specific event triggered, timestamps, and other relevant data needed to sync with your external systems.
Sample JSON Body of 'All Email Replies'
{
"webhook_id": "662218b9cf6b797039a56360",
"webhook_name": "webhook test",
"webhook_event": "ALL_EMAIL_REPLIES",
"org_id": "65099a0dd96fae8ab61130bf",
"workspace_id": "65099a0dd96fae8ab61130c0",
"email_account_id": "65d455a75570b3c6fc5b61ae",
"source_thread_id": null,
"source_message_id": "<CACk81oUWngN95-ruosgMh5k6+BA1Esr0eQzhrCkOO7Ma6TH79A@mail.gmail.com>",
"thread_id": "662219342fbcf7bce6b888e9",
"source_label_ids": [
"INBOX"
],
"source": "SMTP",
"subject": "Re: test webhook",
"from": "Lead <[email protected]>",
"from_email": "[email protected]",
"to": "Sender Joe <[email protected]>",
"camp_id": "662217c8cf6b797039a5635e",
"lead_id": "662217e7cf6b797039a5635f",
"direction": "IN",
"snippet": //snippet of the reply,
"body": // body of the reply,
"is_read": 0,
"status": "ACTIVE",
"modified_at": "2024-04-19T07:09:51.000Z",
"message_id": "<CACk81oUWngN95-ruosgMh5k6+BA1Esr0eQzhrCkOO7Ma6TH79A@mail.gmail.com>",
"references": "<[email protected]>",
"reply_to": "<[email protected]>",
"cc": "[email protected]", //if the lead has cc someone
"to_email": "[email protected]",
"actual_replied_from": "[email protected]" //if a lead replied from a different email address
}
Sample JSON Body of 'Lead Marked as Interested'
{
"webhook_id": "662218b9cf6b797039a56360",
"webhook_name": "webook test",
"webhook_event": "LEAD_MARKED_AS_INTERESTED",
"_id": "662217e7cf6b797039a5635f",
"first_name": null,
"last_name": null,
"email": "[email protected]",
"address_line": null,
"country": null,
"city": null,
"country_code": null,
"phone_number": null,
"company_name": null,
"company_website": null,
"organization_id": "65099a0dd96fae8ab61130bf",
"campaign_id": "662217c8cf6b797039a5635e",
"is_completed": 1,
"current_step": 1,
"email_account_id": "65d455a75570b3c6fc5b61ae",
"created_at": "2024-04-19T07:06:15.663Z",
"modified_at": "2024-04-19T07:13:03.280Z",
"status": "REPLIED",
"label": "INTERESTED",
"last_lead_reply": "I'm interested", //the content of last reply
"actual_replied_from": "[email protected]" //if a lead replied from a different email address
}