Skip to main content
POST
Create Webhook

Authorizations

Authorization
string
header
required

Signalbase API key. Include as a Bearer token in the Authorization header.

Body

application/json

Field names accept snake_case (canonical) or camelCase (endpointUrl, eventTypes).

endpoint_url
string<uri>
required

Destination URL. Must be a valid http/https URL of at most 500 characters. In production, localhost and private/link-local addresses are rejected.

Maximum string length: 500
Example:

"https://example.com/hooks/signalbase"

event_types
enum<string>[]
required

Event types to subscribe to. Duplicates are removed.

Event type a subscription can register for. system.test is accepted but only ever delivered by the Send Test Event endpoint; it never fires automatically.

Available options:
funding.created,
acquisition.created,
job_change.created,
hiring.created,
new_company.created,
investor.created,
system.test
Example:
filters
object

Optional string key/value filters that narrow which events are delivered. Recognized keys: countries, jobCountries, categories, search, teamSize, dateFrom, dateTo, funding, roundFlavor, fundingAmount, acquisitionAmount, healthScore. Unrecognized keys are silently ignored — note the round-type key is funding, not round. For hiring.created events countries matches the job listing country OR the company HQ country (same as the REST hiring endpoint), and jobCountries matches the job listing country only; jobCountries never matches non-hiring events. For investor.created events only countries and search apply. See the Webhooks overview 'Filters' section for value formats.

Example:

Response

Webhook created. data includes the full signing secret (shown only on create).

success
boolean
required
data
object
required

A webhook subscription. List/retrieve/update(no rotation)/delete include secret_preview; create and rotate_secret include the full secret instead.

meta
object
required