List Webhooks

List Webhooks

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app-api.walead.ai/api/v1/hooks/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app-api.walead.ai/api/v1/hooks/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app-api.walead.ai/api/v1/hooks/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app-api.walead.ai/api/v1/hooks/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "url": "<string>",
    "type": "<string>",
    "campaignId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "<string>"
  }
]

{
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>"
}

GET

hooks

list

List Webhooks

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app-api.walead.ai/api/v1/hooks/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app-api.walead.ai/api/v1/hooks/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app-api.walead.ai/api/v1/hooks/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app-api.walead.ai/api/v1/hooks/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "url": "<string>",
    "type": "<string>",
    "campaignId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "<string>"
  }
]

{
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "message": "<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

Parameter	Type	Required	Description
`type`	string	No	Filter by webhook event type (e.g., `lead_tagged_interested`, `message_received`)
`campaignId`	string	No	Filter by specific campaign ID

Available Event Types

When using the type filter, you can specify any of these event types:

Event Type	Description
`lead_tagged_interested`	Lead tagged as “Interested”
`lead_meeting_booked`	Lead tagged as “Meeting Booked”
`lead_status_matched`	Lead accepted by screening
`lead_status_discarded`	Lead discarded by screening
`campaign_completed`	Campaign finished
`message_received`	Lead sent a message
`linkedin_account_disconnected`	LinkedIn account disconnected
`connection_request_accepted`	Lead accepted connection request
`campaign_without_leads`	Active 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

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

API documentation

MCP Integration

Campaigns

Senders

Leads

Sequences

Conversations

Analytics

Webhooks

Overview

Use Cases

Query Parameters

Available Event Types

Examples

List all webhooks

Filter by event type

Filter by campaign

Filter by both type and campaign

Response

Error Responses

Invalid Webhook Type

Authorizations

Query Parameters

Response

​Overview

​Use Cases

​Query Parameters

​Available Event Types

​Examples

​List all webhooks

​Filter by event type

​Filter by campaign

​Filter by both type and campaign

​Response

​Error Responses

​Invalid Webhook Type

Authorizations

Query Parameters

Response

Overview

Use Cases

Query Parameters

Available Event Types

Examples

List all webhooks

Filter by event type

Filter by campaign

Filter by both type and campaign

Response

Error Responses

Invalid Webhook Type