Skip to main content
POST
/
v1
/
hooks
/
subscribe
Subscribe to Webhook
curl --request POST \
  --url https://app-api.walead.ai/api/v1/hooks/subscribe \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>"
}
'
{
  "id": "<string>",
  "url": "<string>",
  "type": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.walead.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Subscribe to a webhook to receive real-time HTTP POST notifications when specific events occur in your workspace.

​
Webhook URL Requirements

  • Must use HTTPS (HTTP is not supported for security)
  • Must be publicly accessible
  • Should respond with a 200 status code within 5 seconds
  • Should handle duplicate events idempotently

​
Available Event Types

Subscribe to one of these event types:
Event TypeDescription
lead_tagged_interestedLead tagged as “Interested”
lead_meeting_bookedLead tagged as “Meeting Booked”
lead_status_matchedLead accepted by screening
lead_status_discardedLead discarded by screening
campaign_completedCampaign finished
message_receivedLead sent a message
linkedin_account_disconnectedLinkedIn account disconnected
connection_request_acceptedLead accepted connection request
campaign_without_leadsActive campaign ran out of leads

​
Example Payloads

​
Lead Event Payload

{
  "leadId": "lead_abc123",
  "campaignId": "campaign_xyz789",
  "campaignName": "Sales Outreach Q1",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "companyName": "Acme Corp",
  "linkedinUrl": "https://www.linkedin.com/in/johndoe",
  "status": "accepted",
  "tag": "Interested"
}

​
Campaign Event Payload

{
  "campaignId": "campaign_xyz789",
  "campaignName": "Sales Outreach Q1",
  "progress": 100,
  "status": "completed"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Body

application/json

Webhook subscription details

​
url
string<uri>
required

HTTPS URL where webhook notifications will be sent

​
type
enum<string>
required

Type of event to subscribe to

Available options:
lead_tagged_interested,
lead_meeting_booked,
lead_status_matched,
lead_status_discarded,
campaign_completed,
message_received,
linkedin_account_disconnected,
connection_request_accepted,
campaign_without_leads

Response

Webhook subscribed successfully

​
id
string

Unique webhook identifier

​
url
string

Webhook URL

​
type
string

Webhook event type

​
createdAt
string<date-time>

ISO 8601 timestamp of creation