signals

Create Signal

Changed on

Create a signal from a catalog preset.

The signal checks its provider daily and imports the qualified leads or companies into a destination list it creates under the same name. Read GET /v1/signals/presets first to pick the preset and learn which detection filters it takes. The signal starts active and runs a first check immediately.

Requires the signals:write scope on the API key.

post/v1/signals

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/signals
  • Auth: HTTP bearer

Request body

signal_type'LINKEDIN_OWN_POST_ENGAGEMENT' | 'LINKEDIN_COMPETITOR_POST_ENGAGEMENT' | 'LINKEDIN_PERSON_POST_ENGAGEMENT' | 'LINKEDIN_KEYWORD_MENTION' | 'LINKEDIN_OWN_COMPANY_FOLLOWERS' | 'LINKEDIN_COMPETITOR_FOLLOWERS' | 'LINKEDIN_COMPANY_PAGE_FOLLOWERS' | 'HIRING_SIGNALS' | 'JOB_DESCRIPTION_KEYWORD' | 'FUNDING_EVENTS' | 'TECH_ADOPTION' | 'NEWS_EVENTS' | 'NEW_JOB' | 'CUSTOM_EVENT' | 'LINKEDIN_PARTNER_FOLLOWERS' | 'LINKEDIN_CUSTOMER_FOLLOWERS' | 'LINKEDIN_PARTNER_POST_ENGAGEMENT' | 'LINKEDIN_CUSTOMER_POST_ENGAGEMENT' | 'LINKEDIN_COMPANY_PAGE_POST_ENGAGEMENT' | 'LINKEDIN_OWN_PROFILE_POST_ENGAGEMENT' | 'LINKEDIN_OWN_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_COMPETITOR_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_PARTNER_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_CUSTOMER_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_OWN_BRAND_MENTION' | 'LINKEDIN_COMPETITOR_MENTION' | 'LINKEDIN_PARTNER_MENTION' | 'LINKEDIN_CUSTOMER_MENTION' | 'LINKEDIN_EVENT_MENTION' | 'COMPETITOR_TECH_ADOPTION' | 'INTEGRATION_TECH_ADOPTION' | 'LINKEDIN_EVENT_PAGE_FOLLOWERS' | 'CHAMPION_CHANGED_JOB' | 'CRM_LIST_ENTRY' required
namestring required
search_filtersFilterTexts
import_target'PEOPLE' | 'COMPANIES'
event_subject'PEOPLE' | 'COMPANIES'
max_per_runinteger nullable

Daily ceiling on imported entries. Cannot be combined with max_companies_per_run.

max_companies_per_runinteger nullable

Daily ceiling on detected companies consumed. Only for a company preset importing people.

max_contacts_per_companyinteger nullable

How many people to import per detected company. Requires max_companies_per_run.

enrich_emailboolean

Whether imported leads get their email enriched.

enrich_phonesboolean

Whether imported leads get their phone enriched.

sequence_template_idstring uuid nullable

Sequence template imported leads are enrolled into. People destinations only.

import_search_filtersFilterTexts

Response

Successful Response

idstring uuid required

Unique identifier of the signal.

namestring nullable required

Name of the signal and of its destination list.

signal_type'LINKEDIN_OWN_POST_ENGAGEMENT' | 'LINKEDIN_COMPETITOR_POST_ENGAGEMENT' | 'LINKEDIN_PERSON_POST_ENGAGEMENT' | 'LINKEDIN_KEYWORD_MENTION' | 'LINKEDIN_OWN_COMPANY_FOLLOWERS' | 'LINKEDIN_COMPETITOR_FOLLOWERS' | 'LINKEDIN_COMPANY_PAGE_FOLLOWERS' | 'HIRING_SIGNALS' | 'JOB_DESCRIPTION_KEYWORD' | 'FUNDING_EVENTS' | 'TECH_ADOPTION' | 'NEWS_EVENTS' | 'NEW_JOB' | 'CUSTOM_EVENT' | 'LINKEDIN_PARTNER_FOLLOWERS' | 'LINKEDIN_CUSTOMER_FOLLOWERS' | 'LINKEDIN_PARTNER_POST_ENGAGEMENT' | 'LINKEDIN_CUSTOMER_POST_ENGAGEMENT' | 'LINKEDIN_COMPANY_PAGE_POST_ENGAGEMENT' | 'LINKEDIN_OWN_PROFILE_POST_ENGAGEMENT' | 'LINKEDIN_OWN_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_COMPETITOR_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_PARTNER_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_CUSTOMER_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_OWN_BRAND_MENTION' | 'LINKEDIN_COMPETITOR_MENTION' | 'LINKEDIN_PARTNER_MENTION' | 'LINKEDIN_CUSTOMER_MENTION' | 'LINKEDIN_EVENT_MENTION' | 'COMPETITOR_TECH_ADOPTION' | 'INTEGRATION_TECH_ADOPTION' | 'LINKEDIN_EVENT_PAGE_FOLLOWERS' | 'CHAMPION_CHANGED_JOB' | 'CRM_LIST_ENTRY' required
status'ACTIVE' | 'PAUSED' | 'ARCHIVED' required
cadence'DAILY' | 'WEEKLY' required
max_per_runinteger nullable required

Daily ceiling on imported entries, when one was set.

max_companies_per_runinteger nullable required

Daily ceiling on detected companies consumed, when one was set.

max_contacts_per_companyinteger nullable required

People imported per detected company, when one was set.

max_per_dayinteger required

Ceiling on the entries the signal imports in one day, resolved from the caps above.

enrich_emailboolean required

Whether imported leads get their email enriched.

enrich_phonesboolean required

Whether imported leads get their phone enriched.

imported_countinteger required

Entries the signal has imported since it was created.

contact_list_idstring uuid nullable required

Destination list, when the signal imports people.

account_list_idstring uuid nullable required

Destination list, when the signal imports companies.

created_atstring date-time required

When the signal was created.

archived_atstring date-time nullable required

When the signal was retired, if it was.

urlstring required

Deep link to the signal in Topo.

list_urlstring nullable required

Deep link to the destination list in Topo.

Changes

  • 4c947c3f2e11Revision changes
    • info

      added the new optional request property

  • 451748979321Revision changes
    • info

      added the new linkedin_watched_engagement enum value to the request property /

    • info

      added the new linkedin_watched_engagement enum value to the request property /