Skip to content
LeadMCPDocs

create alert

POST/signals/alerts

An alert is a source of signals. Read them with `list_signals`. Starts a premium source for one premium credit per lead. Holds premium credits for the first job. With dry_run true, estimates without writing a row.

Premium creditsOne premium credit per new lead, held before each run. Premium credits are held before work starts, and a dry run is free.

An alert is a source of signals. Read them with list_signals. Starts a premium source for one premium credit per lead. Holds premium credits for the first job. With dry_run true, estimates without writing a row.

Request body

kindenumrequired

What to watch. linkedin_profile: the people who react to or comment on the 10 latest posts of one profile. linkedin_post: the people who react to or comment on one post.

linkedin_profilelinkedin_post

targetstringrequired

The LinkedIn URL of the target. A profile URL, such as https://www.linkedin.com/in/<slug>. A post URL of the form https://www.linkedin.com/posts/<slug> or https://www.linkedin.com/feed/update/urn:li:activity:<id>.

cadenceenumoptional

daily runs the alert once a day. manual never runs on its own: it runs only when you call poll_alert. The default is daily.

dailymanual

billing_choiceenumoptional

new_only: the first run sets a baseline and charges nothing for the backlog; later runs collect and charge only new engagers. backfill_and_new: the first run also collects and charges the existing engagers. The default is backfill_and_new.

backfill_and_newnew_only

dry_runbooleanoptional

True returns only the estimate: units, premium_credits, available and sufficient. It holds no credits, starts no job and costs nothing.

Response

The fields inside data.

alertobjectrequired

Show child attributes

kindenumrequired

linkedin_profilelinkedin_post

targetstringrequired

idstringrequired

cadenceenumrequired

dailymanual

billing_choiceenumrequired

backfill_and_newnew_only

activebooleanrequired

last_polled_atanyrequired

removed_atanyrequired

created_atstringrequired

jobobjectrequired

Show child attributes

kindenumrequired

linkedin_profilelinkedin_postlinkedin_company

targetstringrequired

idstringrequired

alert_idanyrequired

statusenumrequired

queuedrunningcompletedpartialno_matchesfailedcancelled

holdintegerrequired

signalsintegerrequired

leadsintegerrequired

settled_atanyrequired

errorstring or nullrequired

scrape_outcomeanyrequired

created_atstringrequired

started_atanyrequired

completed_atanyrequired

Failures

StatusMeaning
400The request shape, a filter key, a value, a cursor or the enrichment mode was rejected.
401The credential is missing, unknown or revoked.
402The daily or the monthly contact credit cap is spent, or the free plan's lifetime pool is.
403Creating alerts requires a paid plan (plan.required).
429The key passed 300 requests a minute or 2 concurrent requests.
503The data is unavailable for a short time.