Why this matters: Standard uptime monitors only check HTTP 200 on your landing page. FunnelReceipt validates the entire commercial pipeline: from form submission to confirmation of receipt by your CRM. Follow the guide below to integrate delivery receipts in under 5 minutes.
1. Generating an API Key
All requests to the Event API require authentication via the Authorization: Bearer <API_KEY> header.
- Navigate to Settings under an Owner or Administrator account.
- In the API Keys section, click Create Key.
- Name the key (e.g.
HubSpot Webhook) and copy the generatedfnr_live_...secret. It is shown only once!
2. Identifying Synthetic Test Leads
FunnelReceipt browser journeys submit forms with synthetic test leads. Every synthetic submission includes identifying HTTP headers:
| Header / Field | Value | Purpose |
|---|---|---|
X-FunnelReceipt-Test | true | Explicit indicator that the request originates from an automated monitor. |
X-FunnelReceipt-Lead-Email | qa-lead-[hash]@funnelreceipt.test | Synthetic lead email address matching the form input. |
Tip: In your CRM or webhook parser, create a simple filter: if the email ends with @funnelreceipt.test, tag the contact as [QA Test] or bypass salesperson notification workflows.
3. CRM Receipt Endpoint (Recommended)
Trigger this endpoint as soon as a lead is accepted or rejected by your CRM or lead buyer. This instantly confirms the pipeline loop in your FunnelReceipt check timeline.
Method & URL: POST https://api.funnelreceipt.com/v1/crm-receipts
Query Parameters:
monitorId(UUID, required) — The ID of the monitor in FunnelReceipt.checkRunId(UUID, required) — The ID of the specific check execution run.
CRM Receipt Code Examples:
curl -X POST "https://api.funnelreceipt.com/v1/crm-receipts?monitorId=YOUR_MONITOR_ID&checkRunId=YOUR_CHECK_RUN_ID" \
-H "Authorization: Bearer fnr_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"crmApiUrl": "https://api.hubspot.com/crm/v3/objects/contacts",
"externalLeadId": "lead_98412",
"status": "delivered",
"occurredAt": "'$(date -u +"%Y-%m-%dT%H:%M:%SZ")'",
"payloadSnapshot": {
"contactId": "123456",
"lifecycleStage": "lead",
"accepted": true
}
}'4. Generic Delivery Events (Event API)
For broader multi-step funnels or partner distribution networks, use the generic events endpoint at POST /v1/events:
externalEventId(string, required) — Unique event or transaction ID.eventType(enum) —lead_accepted,lead_rejected,lead_delivered,lead_failed,crm_receipt.source(string, required) — System identifier (e.g.hubspot,pipedrive,custom_api).occurredAt(ISO datetime, required) — Timestamp in UTC.metadata(object, optional) — Up to 50 key-value pairs for context.
Generic Event Code Examples:
curl -X POST "https://api.funnelreceipt.com/v1/events" \
-H "Authorization: Bearer fnr_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"externalEventId": "evt_order_84920",
"eventType": "lead_delivered",
"source": "pipedrive",
"occurredAt": "'$(date -u +"%Y-%m-%dT%H:%M:%SZ")'",
"monitorId": "YOUR_MONITOR_ID",
"metadata": {
"campaign": "google_search_ua",
"buyer": "partner_agency",
"dealValue": 1200
}
}'5. No-Code Webhooks (Make, Zapier, n8n)
If your lead routing relies on No-Code automation tools, you can emit delivery receipts with a single HTTP Request module:
- Insert an HTTP / Webhook action immediately after your CRM Contact Creation block.
- Set the method to POST and the URL to
https://api.funnelreceipt.com/v1/events. - Add headers:
Authorization: Bearer fnr_live_...andContent-Type: application/json. - Provide the JSON payload mapping the CRM contact ID and status.
6. Response Codes & Error Handling
| Status | Description | Next Step |
|---|---|---|
202 Accepted | Event queued successfully | Receipt linked to check timeline. |
401 Unauthorized | Invalid or missing API key | Check the Authorization: Bearer ... header. |
404 Not Found | Monitor not found | Verify the monitorId parameter. |
413 Payload Too Large | Payload exceeds 64 KB | Trim unnecessary payload snapshot fields. |
422 Unprocessable | Validation error | Check ISO 8601 timestamps and required fields. |