Create an alert
create_alertCreates a recurring alert. Writing the alert does not use credits. Credits apply when a run delivers records. preview_alert returns the credit quote for the first run. Requires name and filters, the same fields as get_projects. Optional share block {mode, userIds, optOutUserIds}; sharing requires a paid plan. enrichContacts: true adds contact lookup on each run and costs 1 credit per project where a contact is found, on a paid plan or trial. Optional notify.emailTo (up to 5 extra addresses) and notify.webhookUrl save destinations outside this account. This call stores them and does not send. Delivers private leads by default. leadTypes inside filters (for example ["private","public"]) widens that set. Confirm with the user first: the name, the place, and the size floor.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>",
"filters": "<filters>"
},
"name": "create_alert"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The alert's name. | |
| share | No | Team sharing. Any member of a shared alert may read, edit, run and delete it. Sharing requires a paid plan. | |
| active | No | ||
| notify | No | ||
| cadence | No | Defaults to weekly. | |
| filters | Yes | At least one filter, in the same vocabulary as get_projects — integer geo ids from list_locations, project-type values from get_project_types. Private leads by default; add leadTypes (e.g. ["private","public"]) inside this object to change the view. | |
| enrichContacts | No | Find Contact Info on every run: each run looks up developer emails and phones on the records it delivered BEFORE notifying, then get_alert_matches with include "contacts" returns them, best contacts first. 1 credit per project the first time a contact is found, nothing otherwise. Needs a paid plan or live trial. Confirm with the user before turning it on. | |
| maxRecordsPerRun | No | Cap on records (= credits) one run may deliver. |