Skip to main content
POST
Create a Custom Signal Definition

Authorizations

Authorization
string
header
required

API key authentication. Include as Bearer token in Authorization header.

Body

application/json
name
string
required

A short name for the signal, e.g. "First sales leader". The slug is derived from it.

Required string length: 3 - 80
description
string
required

What a post must say for it to count, as a plain-English rule about the author's own company: the event, what makes it that event and not a neighbour of it, and anything to exclude. Two or three sentences. Compiled into search phrases and a matching rule — write the rule, not a keyword list.

Required string length: 20 - 1500
targets
string[]

Company website domains or LinkedIn company URLs. Given, the definition only sweeps posts from these companies (a monitor watching the new slug holds them); omitted, it sweeps every post. companies is accepted as an alias.

Required array length: 1 - 100 elements
Maximum string length: 500

Response

Definition created and queued for compilation.

success
boolean
data
object

One of your team's own definitions, as the Custom signals page shows it.

meta
object