Skip to main content
POST
/
api
/
v1
/
signal
/
deploy
/
social-listening-agent
Deploy Social Listening Signal
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/signal/deploy/social-listening-agent \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "name": "<string>",
  "search_query": "<string>",
  "timeframe": 90,
  "signal_target": "account",
  "icp_id": 123,
  "repeat": false,
  "account_audience_name": "<string>",
  "people_audience_name": "<string>",
  "max_credit_limit": 123,
  "enable_safe_crm_addition": false,
  "auto_enrich_people_emails": false,
  "advanced_people_finder": false
}
'
{
  "signal_id": 123,
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.openfunnel.dev/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-API-Key
string
required
​
X-User-ID
string
required

Body

application/json
​
name
string
required

Name/identifier for this signal run

​
search_query
string
required

LinkedIn search keyword (e.g. 'AI tools')

​
timeframe
integer
required

Time limit in days (1-180)

Required range: 1 <= x <= 180
​
signal_target
enum<string>
default:account

Whether to discover accounts or people

Available options:
account,
people
​
icp_id
integer | null

ICP ID to use for filtering

​
repeat
boolean | null
default:false

Run this signal daily to discover new results (default: false, runs once)

​
account_audience_name
string | null

Audience name for auto-adding discovered accounts (default: ' - Accounts')

​
people_audience_name
string | null

Audience name for people enrichment (default: ' - People')

​
max_credit_limit
integer | null

Credit limit to enforce on this signal. Signal will stop once max_credit_limit is hit

​
enable_safe_crm_addition
boolean | null
default:false

Auto-add discovered accounts to CRM. New/unassigned accounts are created and assigned to you; existing accounts get signals enriched. Ownership is never changed.

​
auto_enrich_people_emails
boolean | null
default:false

Automatically enrich discovered people with work emails. Uses email enrichment credits.

​
advanced_people_finder
boolean | null
default:false

Enable advanced LLM-based people finder in addition to fast enrichment. Consumes OpenFunnel credits

Response

Successful Response

Common response shape for signal deployment endpoints. Returns at minimum the signal_id and a status. Some agents return additional fields (e.g. message, campaign_id) which are not documented in this shape.

​
signal_id
integer
required

ID of the deployed signal. Use this to poll signal status or fetch results.

​
status
string
required

Deployment status (e.g. 'accepted', 'running').