List the signal library (catalog) — START HERE
The entry point for building a Rodz integration. Browse the full catalog of signal types you can create — the whole Rodz signal engine in one call, generated from the same models the API validates against, so it cannot drift from what actually works on the wire. A full integration is: call this once to pick a signal type -> POST createEndpoint with a body built from configParameters to create it -> receive leads on your webhookUrl shaped like outputFields -> POST /api/v1/signals/{signalId}/test-webhook to fire a synthetic test event, or .../replay-webhook to resend a real past one, while you build your receiver.
Input: none (just your API key).
Output: an array of signal types. Each entry gives, per type: kind (an open-ended signal or a watchlist narrowed to a list you supply), a use-case description, configParameters — the CLOSED set of request fields createEndpoint accepts (see unknownParameters for what happens to anything else), pricingModel — credits only, never euros, since you set your own price per credit for your customers, and at your account's own rate when it has a negotiated one — outputFields — the exact webhook payload shape — and relatedSignalTypes for the signal types it is easy to confuse this one with (a narrower watchlist sibling, the account_watchlist umbrella, or a similar-looking signal with different targeting). Use createEndpoint + configParameters to build the POST /api/v1/signals/... request, and outputFields to know what each delivered lead contains.
Request
- Base URL: https://api.rodz.io (the document declares no server; this is the origin it was published from)
- URL: https://api.rodz.io/api/v1/signal-types
- Auth: HTTP bearer
Response
Successful Response
Example response
{
"signalTypes": [
{
"category": "competitive_intelligence",
"configParameters": {
"companySizeFilters": {
"description": "Only include leads from companies of these sizes",
"items": {
"enum": [
"Self-employed",
"1-10",
"11-50",
"51-200",
"201-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+"
]
},
"type": "array"
},
"getEmails": {
"default": false,
"description": "Enable email enrichment (0.5 credit/lead, charged only on success)",
"type": "boolean"
},
"linkedinCompanyUrls": {
"description": "Competitor LinkedIn company page URLs to monitor for new connections",
"items": {
"type": "string"
},
"type": "array"
},
"targetPersonas": {
"description": "Persona names to keep (see GET /api/v1/personas)",
"items": {
"type": "string"
},
"type": "array"
}
},
"createEndpoint": "/api/v1/signals/competitor-connections",
"creditsPerLead": 5,
"deprecatedCreateEndpoints": [
"/api/v1/signals/competitor-relationships"
],
"description": "Get the new 1st-degree LinkedIn connections of your competitors' salespeople — typically their prospects and customers. Input competitor LinkedIn company URLs; each new connection matching your persona/ICP config is pushed to your webhook as an enriched lead.",
"kind": "signal",
"name": "Competitor Connections",
"outputFields": [
"signal.type",
"signal.tracked_company",
"contact.first_name",
"contact.last_name",
"contact.email",
"contact.title",
"contact.linkedin_profile_url",
"contact.matched_persona",
"company.name",
"company.website",
"company.linkedin_url"
],
"pricingModel": {
"addOns": [
{
"creditsOnSuccess": 0.5,
"description": "Finds a professional email address for the contact. Charged once per lead, only on success.",
"parameter": "getEmails"
}
],
"baseCredits": 3,
"unit": "per_lead_delivered"
},
"relatedSignalTypes": [
{
"note": "Can also be watched as part of `account_watchlist`, the umbrella that combines this with every other event on one company list, billed at one flat rate.",
"signalTypeId": "account_watchlist"
}
],
"signalTypeId": "competitor_relationship_monitoring",
"unknownParameters": "Any key not listed here is silently accepted and ignored — ignoring it is NOT an error, but it also does nothing. A key you invent (e.g. a results-count limit) has no effect; only the keys listed in `configParameters` change behaviour."
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.