Integration documentation

Send opportunity rows into the tools your team already uses.

Each send delivers one workflow-ready opportunity as JSON to a Zapier, Make, n8n, or custom HTTPS webhook. This reference covers the current payload, delivery rules, and practical setup recipes.

Quick start

Connect a webhook in four steps

No API key or custom request code is needed for the standard in-product flow.

Step 1
Create the trigger
Create a catch-hook or webhook trigger in your destination tool and copy its HTTPS URL.
Step 2
Open a full report
Choose a row marked Workflow ready, then select Send to Workflow.
Step 3
Send a sample
Paste the webhook URL and send. The destination uses this event to discover the fields.
Step 4
Map and verify
Map the opportunity fields, activate the automation, and send another row to test the live path.

Payload

Delivery envelope

The webhook receives an HTTP POST with Content-Type: application/json.

product: String. Always Opportunity Scanner.
sent_at: String. ISO 8601 timestamp created when delivery begins.
opportunity: Object. The server-generated opportunity record described below.

Optional properties with no value are omitted from the JSON. Build mappings that tolerate missing optional fields.

{
  "product": "Opportunity Scanner",
  "sent_at": "2026-07-12T15:42:18.214Z",
  "opportunity": {
    "scanId": "scan_01JZ8Y3QF2",
    "opportunityId": "opp_01JZ8Y8K9M",
    "opportunity": "County behavioral health services procurement",
    "targetOrganization": "Example County Health Department",
    "targetAccount": "Example County Health Department",
    "source": "SAM.gov",
    "signalType": "Active procurement",
    "recordClass": "current",
    "currentValidatedAt": "2026-07-12T15:40:02.000Z",
    "opportunityType": "Agency procurement",
    "buyerPartnerType": "Public agency",
    "revenueMotion": "Sell to Agency",
    "actionability": "High Actionability",
    "actionabilityScore": 86,
    "contactPath": "Procurement office",
    "contactStrategy": "procurement_office",
    "recommendedContactRoles": ["Contracting officer", "Program manager"],
    "nextStep": "Review the notice and confirm response requirements.",
    "nextBestAction": "Review the notice and confirm response requirements.",
    "manualResearchInstruction": "Confirm the incumbent and submission method.",
    "crmNote": "Example County has an active behavioral health procurement...",
    "outreachAngle": "Connect the service to the county's stated access goal.",
    "followUpTask": "Assign an owner to review the source record today.",
    "timeSensitivity": "Immediate",
    "pursuitDifficulty": "Medium",
    "workflowPayloadReady": true,
    "workflowPayloadReason": "Source and next action are specific enough to route.",
    "sourceStatus": "Active",
    "sourceDeadline": "2026-08-14",
    "sourceEvidence": "The notice requests qualified behavioral health providers...",
    "sourceUrl": "https://sam.gov/opp/example"
  }
}

Field reference

Opportunity object

"Required" means the server will not attempt delivery without a usable value. "Conditional" means one of the two target fields must be present.

Field	JSON type	Delivery	Meaning
scanId	string	Required	ID of the scan that produced the opportunity.
opportunityId	string	Required	ID of the opportunity within the scan.
opportunity	string	Required	Human-readable opportunity headline.
targetOrganization	string	Conditional	Agency, buyer, recipient, partner, or other organization to pursue. At least this field or targetAccount is required.
targetAccount	string	Conditional	CRM-oriented alias for the target organization. At least this field or targetOrganization is required.
source	string	Required	Name of the public source behind the signal.
signalType	string	Optional	Display label for the source category, such as Active procurement or Funded buyer.
recordClass	"current" \| "evidence"	Required	Separates verified live postings from historical funded-buyer evidence.
currentValidatedAt	string	Current only	ISO timestamp of the latest source validation. Omitted for evidence records.
awardYear	number	Evidence only	Public award year when the historical record provides one.
periodEnd	string	Evidence only	Historical period-of-performance end. This is not a deadline.
opportunityType	string	Optional	Estimated commercial opportunity classification.
buyerPartnerType	string	Optional	Classification of the likely buyer, recipient, partner, or channel target.
revenueMotion	string	Required	Recommended route to revenue, such as Sell to Agency, Direct Apply, or Partner with Recipient.
actionability	string	Optional	Actionability label: High Actionability, Medium Actionability, or Low Actionability.
actionabilityScore	number	Optional	Numeric actionability score generated by Opportunity Scanner.
contactPath	string	Optional	Human-readable label for the recommended route to the right office or person.
contactStrategy	string	Required	Machine-friendly contact strategy used to route the opportunity.
recommendedContactRoles	string[]	Optional	Recommended job functions or roles to locate.
nextStep	string	Optional	Human-readable next step. Currently mirrors nextBestAction.
nextBestAction	string	Required	The recommended immediate action for the opportunity owner.
manualResearchInstruction	string	Optional	Specific research instruction when more qualification is useful.
crmNote	string	Required	Context formatted for a CRM note or account activity.
outreachAngle	string	Optional	Suggested source-backed angle for outreach or internal positioning.
followUpTask	string	Optional	Suggested follow-up task for the opportunity owner.
timeSensitivity	string	Optional	Timing classification generated from the source and pursuit context.
pursuitDifficulty	string	Optional	Estimated difficulty of pursuing the opportunity.
workflowPayloadReady	boolean	Required	Always true for a delivered webhook. Opportunities that are not ready are rejected before delivery.
workflowPayloadReason	string	Required	Explanation of why the opportunity is ready for workflow or what must be checked first.
sourceStatus	string	Optional	Current status classification for the source record.
sourceDeadline	string	Current only	Verified future close date for a current record. Never delivered for funded-buyer evidence.
sourceEvidence	string	Required	Evidence summary grounded in the public source record.
sourceUrl	string	Optional	Public source URL. Included when a full-report opportunity is sent.

Recipes

Zapier, Make, and n8n setup

Zapier

Create or update a CRM record and assign a follow-up task.

Destination field	Payload value
Account / company	opportunity.targetAccount
Deal / opportunity name	opportunity.opportunity
Pipeline or motion	opportunity.revenueMotion
Notes	opportunity.crmNote
Task	opportunity.nextBestAction
Source URL	opportunity.sourceUrl

1Create a Zap with Webhooks by Zapier as the trigger and choose Catch Hook.
2Copy the HTTPS hook URL. In a full Opportunity Scanner report, choose Send to Workflow on a workflow-ready row, paste the URL, and send the opportunity.
3In Zapier, test the trigger and confirm that product, sent_at, and the nested opportunity object appear.
4Add your CRM action. Map opportunity.targetAccount to the company or account, opportunity.opportunity to the deal name, opportunity.crmNote to notes, and opportunity.sourceUrl to the source-link field.
5Add a task action using opportunity.nextBestAction as the task title. Use opportunity.sourceDeadline only after checking that the destination accepts its text format.
6Turn on the Zap, then send a second opportunity to verify the live path.

Make

Add a qualified row to Airtable, a CRM, or a shared opportunity table.

Destination field	Payload value
Target	opportunity.targetOrganization
Signal	opportunity.opportunity
Evidence	opportunity.sourceEvidence
Contact route	opportunity.contactPath
Owner action	opportunity.nextBestAction
Source status	opportunity.sourceStatus

1Create a scenario and add Webhooks > Custom webhook as the first module.
2Create the webhook, copy its HTTPS address, and leave Make waiting for a sample.
3Send a workflow-ready opportunity from the full report to that address. Make will infer the nested opportunity fields from the sample.
4Add the destination module. Map the target, headline, evidence, motion, contact strategy, next action, and source URL into separate fields.
5Add a filter after the webhook if needed: opportunity.workflowPayloadReady equals true. Delivered Opportunity Scanner webhooks already satisfy this rule, but the filter documents the scenario's expectation.
6Run once with another row, inspect the created record, then schedule or activate the scenario.

n8n

Route opportunities by revenue motion and create an owned action.

Destination field	Payload value
Switch value	{{$json.opportunity.revenueMotion}}
Account	{{$json.opportunity.targetAccount}}
Record title	{{$json.opportunity.opportunity}}
CRM note	{{$json.opportunity.crmNote}}
Task	{{$json.opportunity.nextBestAction}}
Evidence link	{{$json.opportunity.sourceUrl}}

1Add a Webhook node, set the HTTP Method to POST, and use the node's HTTPS test URL while building the workflow.
2Listen for a test event, then send a workflow-ready opportunity from Opportunity Scanner to the test URL.
3Add a Switch node using {{$json.opportunity.revenueMotion}}. Create routes such as Sell to Agency, Sell to Funded Buyer, and Partner with Recipient.
4On each route, add the appropriate CRM, project, email, or messaging node. Reference nested values with expressions such as {{$json.opportunity.nextBestAction}}.
5Configure the Webhook node to respond immediately or otherwise return a successful 2xx response within eight seconds.
6Activate the workflow and replace the test URL in Opportunity Scanner with n8n's HTTPS production URL for future sends.

Delivery rules

What your endpoint must do

These limits apply to the current webhook sender.

HTTPS only

The destination URL must use HTTPS and cannot contain embedded username/password credentials.

Return 2xx

Any non-2xx destination response is treated as a failed delivery.

Eight seconds

The destination must accept the request within eight seconds.

One attempt

Opportunity Scanner does not currently retry a failed webhook automatically. Send the row again after correcting the issue.

Errors shown in Opportunity Scanner

Status	Meaning	What to check
400	Invalid request	The webhook URL is missing, is not HTTPS, includes embedded credentials, or the scan/opportunity IDs are missing.
403	Full report required	Sending to workflow is available only for a full report.
404	Record not found	The scan or opportunity no longer matches a stored record.
413	Payload too large	The opportunity object exceeds 25,000 bytes.
422	Not workflow ready	A required field is empty or the opportunity needs more research.
502	Delivery failed	The destination rejected the request with a non-2xx response or could not be reached.
504	Delivery timed out	The destination did not accept the request within eight seconds.

Operational note

Webhook requests are server-generated from the stored scan and opportunity. The current sender does not add a signature or authorization header, so treat the destination URL as a secret, use the access controls offered by your automation platform, and avoid logging the full URL.

Always recheck the live source before outreach, submission, or a deadline-sensitive action. The webhook moves research into workflow; it does not replace source verification.