Sales Signals API Guide
Overview
The Sales Signals API lets you set up, manage, and receive notifications (signals) about important events for domains (websites/companies) you care about. You can configure what you track, how you receive notifications, and review the history and status of all your signals.
Key API Entities:
- Signals: What you want to track (e.g., traffic changes, new markets, intent)
- Webhooks: Where the notifications should be sent (your endpoint URLs)
- Domains: The websites/companies you're monitoring
- Events: The log/history of all signal notifications
- Description endpoint: Shows you all valid values and configuration options for each signal type
API Architecture Cheat Sheet
| Endpoint name | Endpoint type | Description |
|---|---|---|
| Description | Get | Returns supported parameters and valid options for each signal |
| Signals - Get All | Get | Shows all your configured signals |
| Signals - Archive | Post | Archives (pauses) a specific signal by ID |
| Signals - Create Traffic Changes | Post | Create traffic change signals |
| Signals - Create News | Post | Create new market traffic signals |
| Signals - Create Intent | Post | Create intent signals |
| Signals - Create AdNetworks | Post | Create adnetwork signals |
| Signals - Create Technology | Post | Create technology signals |
| Signals - Create E-commerce | Post | Create e-commerce signals |
| Webhooks - Get All Subscriptions | Get | Shows all subscribed webhook URLs |
| Webhooks - Add | Post | Registers a new endpoint URL for notifications |
| Webhooks - Archive | Post | Disables an existing webhook (stops notifications) |
| Webhooks – Authorization | Post | Verify webhook authenticity by sending back the hash and payload. |
| Domains - Subscribe | Post | Subscribe domains for monitoring |
| Domains - Unsubscribe | Post | Unsubscribe domains from monitoring |
| Domains - Lists | Post | Returns all domains subscribed for monitoring. |
| Events - Resend | Post | Resends previously detected events to your endpoints |
| Events - History | Post | Shows the log/history of sent events from the past wee |
Summary Flow
- Query the description endpoint
- Create signals with required and supported parameters
- Set up webhooks for each type of signal you want to receive
- Subscribe domains to monitor
- Monitor events—check for failures, and resend as needed
- Deactivate signals or webhooks when they're no longer relevant
Updated about 11 hours ago