Skip to main content
POST
Create a Custom alert
Paste the URL of a LinkedIn Sales Navigator search, the same one you would paste in the app’s Custom signal:
  • A people search (https://www.linkedin.com/sales/search/people...) creates a CUSTOM_LEAD alert. Each run is a lead search.
  • A company search (https://www.linkedin.com/sales/search/company...) creates a CUSTOM_ACCOUNT alert. Each run is a company list.
Pipecorn saves the search in your Sales Navigator account and runs it right away, then daily, weekly or monthly (default daily). After the first run, each run only picks up the results Sales Navigator reports as new since the previous one. max_results (1 to 2500, default 2500) caps the first run only.

Get the new results

There are two ways to receive the results of each run:
  • Webhook. Pass webhook_url and each run posts its results there when it finishes: lead runs post the same payload as People search, company runs the same payload as Create a List. For lead alerts, webhook_streaming: true posts the leads one by one as they are found.
  • Polling. Call Retrieve an Alert with since set to the checked_at of your previous call. It returns only the runs created since then, each with a results_url to fetch its leads or companies. A run whose status is not finished yet is still running: fetch its results_url again later.
Delete the alert with Delete an Alert.

Requirements and limits

  • Your LinkedIn account must be connected to Pipecorn with Sales Navigator. The search runs on that account.
  • A Sales Navigator account holds at most 50 saved searches.
  • Each alert counts against your plan’s alert limit.
  • Lead runs enrich the leads they find and spend credits like People search.

Authorizations

X-API-KEY
string
header
required

Your API key

Body

application/json
name
string
required

Name of the alert

Example:

"VP Sales in France"

search_url
string<uri>
required

Sales Navigator search URL, starting with https://www.linkedin.com/sales/search/people (leads) or https://www.linkedin.com/sales/search/company (accounts)

Example:

"https://www.linkedin.com/sales/search/people?query=(filters:List((type:CURRENT_TITLE,values:List((text:VP%20Sales,selectionType:INCLUDED)))))"

frequency
enum<string>
default:daily

How often the alert runs. Case-insensitive

Available options:
daily,
weekly,
monthly
max_results
integer
default:2500

Maximum number of results the first run extracts. Later runs pick up every new result

Required range: 1 <= x <= 2500
webhook_url
string<uri>

URL each run posts its results to when it finishes. Lead runs post the same payload as POST /leads; company runs post the same payload as POST /lists

Example:

"https://hooks.example.com/pipecorn"

webhook_streaming
boolean
default:false

Lead alerts only. When true, leads are posted to webhook_url one by one as they are found instead of once the run finishes

Response

The alert was created and its first run started

alert
object
required