Skip to main content
POST
Create Signal Agent
A Signal Agent is created as a draft by default. Pass segmentType, signalProcessingType and activate: true to run the full setup and start monitoring immediately. filters are validated against the chosen type — use List allowed filters to discover which filters a type accepts.
Pass campaignId with signalProcessingType: "push_to_campaign" to link the new agent to that campaign as its signal trigger in the same call — same effect as Add Signal Agent trigger. It requires the campaignSignalTrigger beta. If the call is refused (400, 403, 404 or 409), no agent is created. campaignId is not accepted by Update Signal Agent: to link an existing agent, use Add Signal Agent trigger.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
name
string
required

Display name

type
enum<string>
required

Signal type to monitor

Available options:
companyIsHiring,
companyRaisedFunds,
recruitmentCampaign,
newHire,
companyEmployeeVisitedMyWebsite,
customSignals,
competitorConnections,
competitorReactions,
technologyChange,
linkedinPeopleProfile,
linkedinCompanyProfile,
mergersAcquisitions,
promotion,
linkedinKeywords,
republishedJobOffers,
buyingIntent,
newProductLaunch,
companyAward,
newPartnership,
newOffice,
closingOffice,
costCutting,
outagesAndSecurityBreaches,
lawsuitsAndLegalIssues,
githubStargazer
filters
object[]

Filters to apply (validated against the signal type)

emoji
string

Emoji shown next to the agent name (defaults to a random emoji)

segmentType
enum<string>

Entity sourcing. Only all is supported via the API. Required together with signalProcessingType when activate is true.

Available options:
all
signalProcessingType
enum<string>

How detected signals are processed

Available options:
manual,
create_opportunity,
push_to_campaign
signalOpportunityTemplate
object

Task/opportunity template applied to each signal when signalProcessingType is create_opportunity.

personaId
string

Persona (pdp_xxx) used to source contacts from the People Database. Only for a company Signal Agent with signalProcessingType = push_to_campaign whose signal type does not already ship its own contact (those company signals carry no contact, so the persona is the only way to know who to reach). Optional; rejected on any other configuration.

campaignId
string

Campaign (cam_xxx) to link as this Signal Agent's signal trigger, in the same call: every new signal pushes its contact into that campaign as a lead. Only with signalProcessingType = push_to_campaign. A campaign set up as manual in the lemlist app is refused (409). Requires the campaignSignalTrigger beta. Optional; on any refusal no agent is created.

Example:

"cam_ExAmPlE4k8Qz2Wn7R"

activate
boolean

Fully set up and activate the agent. Requires segmentType and signalProcessingType.

Response

Created

data
object

A Signal Agent (watch list) configuration.