Skip to main content
GET
/
v1
/
hooks
/
list
List Webhooks
curl --request GET \
  --url https://app-api.walead.ai/api/v1/hooks/list \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "url": "<string>",
    "type": "<string>",
    "campaignId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "<string>"
  }
]

​
Overview

Retrieves a list of all webhooks subscribed in your workspace. You can filter webhooks by event type and campaign ID to find specific subscriptions.

​
Use Cases

  • Audit: View all active webhook subscriptions in your workspace
  • Management: Identify which webhooks are configured for specific campaigns
  • Debugging: Verify webhook configurations and URLs

​
Query Parameters

ParameterTypeRequiredDescription
typestringNoFilter by webhook event type (e.g., lead_tagged_interested, message_received)
campaignIdstringNoFilter by specific campaign ID

​
Available Event Types

When using the type filter, you can specify any 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

​
Examples

​
List all webhooks

curl --request GET \
  --url 'https://api.walead.ai/v1/hooks/list' \
  --header 'x-api-key: <api-key>'

​
Filter by event type

curl --request GET \
  --url 'https://api.walead.ai/v1/hooks/list?type=message_received' \
  --header 'x-api-key: <api-key>'

​
Filter by campaign

curl --request GET \
  --url 'https://api.walead.ai/v1/hooks/list?campaignId=campaign_xyz789' \
  --header 'x-api-key: <api-key>'

​
Filter by both type and campaign

curl --request GET \
  --url 'https://api.walead.ai/v1/hooks/list?type=lead_tagged_interested&campaignId=campaign_xyz789' \
  --header 'x-api-key: <api-key>'

​
Response

The endpoint returns an array of webhook objects with the following structure: 
[
  {
    "id": "webhook_abc123",
    "url": "https://your-domain.com/webhooks/walead",
    "type": "message_received",
    "campaignId": "campaign_xyz789",
    "createdAt": "2024-03-15T10:30:00Z",
    "status": "active"
  },
  {
    "id": "webhook_def456",
    "url": "https://your-domain.com/webhooks/leads",
    "type": "lead_tagged_interested",
    "campaignId": null,
    "createdAt": "2024-03-14T14:20:00Z",
    "status": "active"
  }
]

​
Error Responses

​
Invalid Webhook Type

{
  "statusCode": 400,
  "message": "Invalid webhook type. Valid types: 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"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Query Parameters

​
type
enum<string>

Filter by webhook event type

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
​
campaignId
string

Filter by campaign ID

Response

List of webhooks retrieved successfully

​
id
string

Webhook unique identifier

​
url
string

Webhook URL endpoint

​
type
string

Webhook event type

​
campaignId
string | null

Associated campaign ID (if applicable)

​
createdAt
string<date-time>

Webhook creation timestamp

​
status
string

Webhook status