<!-- /index.md -->

*Architera to Your system*

# One lead format, sent to your system

Every lead from a website, configurator, stock page or conversation is the same JSON, with every key always present. The test API on this page needs no account.

- [I look after IT at a dealership](#connections): Find the route that fits your system
- [I build a DMS or CRM](/connections/https-webhook#w-quickstart): Try a signed synthetic request in Node, Python, PHP or .NET
- [I review security for a partner](/connections/https-webhook#w-data): See what data leaves, and what comes back

**Test API: One lead**

```bash
curl "https://developer.architera.ai/sandbox/leads" \
  -H "Authorization: Bearer alk_test_public_sandbox"
```

**Test API: Empty**

```bash
curl "https://developer.architera.ai/sandbox/leads?simulate=empty" \
  -H "Authorization: Bearer alk_test_public_sandbox"
```

**Test API: 401**

```bash
curl "https://developer.architera.ai/sandbox/leads?simulate=401" \
  -H "Authorization: Bearer alk_test_public_sandbox"
```

**Test API: 429**

```bash
curl "https://developer.architera.ai/sandbox/leads?simulate=429" \
  -H "Authorization: Bearer alk_test_public_sandbox"
```

## Connections
Every connection is available on request and activated per dealer.
| Name | Direction | What it does | How |
|---|---|---|---|
| HTTPS webhook | Out | HTTPS POST delivery supports signing when configured; examples use the public synthetic sandbox. | HTTPS; configured signing |
| Pull API | Out | Your system asks Architera for new leads. | HTTPS with an API key |
| Email JSON | Out | Each lead reaches a mailbox as a JSON file, with no code on your side. | Email attachment |
| SAP | Out | Lead payloads for a configured SAP HTTPS endpoint. | HTTPS webhook |
| Inventory MCP | Out | An assistant reads an organization's published stock. | Model Context Protocol |
| Lead API | In | Your system sends a lead into Architera. | HTTPS with an API key |
| Keyloop Enquiry Manager | In | Website enquiries arrive as leads. | Credentials from the dealer |
| Stock feed | In | Architera reads your stock from a hosted file. | CSV, XML or JSON |
| Autoline CRiS | Both | Customers, vehicles and leads move both ways. | Scheduled file exchange |
| Website embed | Both | Stock, configurator and test drive inside your own website. | Script tag |
| Web chat widget | Both | A conversation on your website, answered from Architera. | Script tag |

## The lead

A key with no value is `null`, never missing, so a parser written once keeps working. `vehicle` and `pricing` are `null` when no car was involved, such as a lead from a conversation.

- `schema`: Format, delivery ids, and whether this is a test lead
- `org`: The organization the lead belongs to
- `event`: A stable event id, what happened and when, with a warm or hot temperature
- `customer`: Identity, contact details and address, in 21 keys
- `dealer`: Where the lead came from and where it was routed
- `vehicle`: The car, configured or in stock: identity, specs, options
- `pricing`: What the buyer saw, kept apart from manufacturer figures
- `payment`: Outcome and provider reference for any money taken
- `additionalFormFields`: Extra questions the form asked
- `selections`: Purchase type, finance inputs, trade-in, services, delivery
- `consent`: What was recorded. `null` means no record, never no
- `links`: Back to the lead and to what the buyer saw
- `provider`: Which product produced the lead

**sample-lead.v1.json**

```json
{
  "schema": "architera.lead/v1",
  "schemaVersion": "1.4.0",
  "generatedAt": "2026-11-02T09:14:07Z",
  "deliveryId": "00000000-0000-4000-8000-000000000901",
  "idempotencyKey": "architera/lead/fab4a342efc153003fcb5569592c405f240f175ff218c6e8eeb9b6ba53265402",
  "sequence": 1,
  "isResend": false,
  "isTest": true,
  "org": {
    "id": "00000000-0000-4000-8000-000000000001",
    "slug": "example-motors",
    "name": "Example Motors"
  },
  "event": {
    "id": "00000000-0000-4000-8000-000000000005",
    "type": "atlas.enquiry_submitted",
    "journey": "enquiry",
    "occurredAt": "2026-11-02T09:13:54Z",
    "temperature": "warm",
    "temperatureReason": "enquiry_submitted",
    "temperatureRulesVersion": "1.0"
  },
  "customer": {
    "id": "00000000-0000-4000-8000-000000000002",
    "externalIds": {},
    "salutation": "ms",
    "firstName": "Alex",
    "lastName": "Sample",
    "email": "alex.sample@example.com",
    "phone": "+15555550142",
    "companyName": null,
    "vatId": null,
    "dateOfBirth": null,
    "nationality": null,
    "addressLine1": "1 Example Street",
    "addressLine2": null,
    "district": null,
    "city": "Exampleville",
    "region": null,
    "postcode": "00000",
    "poBox": null,
    "addressCountry": "ZZ",
    "preferredLanguage": "en",
    "preferredChannel": "email"
  },
  "dealer": {
    "attributionLocation": {
      "id": "00000000-0000-4000-8000-000000000003",
      "name": "Example Motors Central",
      "dealerCode": "EX-01",
      "externalIds": {}
    },
    "vehicleLocation": {
      "id": "00000000-0000-4000-8000-000000000003",
      "name": "Example Motors Central",
      "dealerCode": "EX-01",
      "externalIds": {}
    },
    "buyerSelectedLocation": null,
    "buyerSelectedRole": null,
    "routedLocation": {
      "id": "00000000-0000-4000-8000-000000000003",
      "name": "Example Motors Central",
      "dealerCode": "EX-01",
      "externalIds": {}
    },
    "routingRule": "vehicle_location",
    "routingRuleVersion": "1.0",
    "notificationEmail": "leads@example.com"
  },
  "vehicle": {
    "kind": "in_stock",
    "identity": {
      "vin": "XTST0000000000142",
      "stockNumber": "S-0142",
      "sourceVehicleId": "FEED-0142",
      "modelId": null,
      "configurationId": null,
      "onlineCode": null,
      "vehicleKey": null
    },
    "descriptive": {
      "brand": "example",
      "make": "Example",
      "model": "Tourer",
      "variant": "Tourer 2.0 Hybrid",
      "line": "Comfort",
      "modelYear": 2025,
      "modelYearCode": null,
      "modificationYearCode": null,
      "bodyStyle": "Estate",
      "condition": "used",
      "mileageKm": 12400,
      "exteriorColour": "Slate Grey",
      "interiorColour": "Black"
    },
    "specs": [
      {
        "key": "power",
        "label": "Power",
        "value": 147,
        "unit": "kW"
      },
      {
        "key": "torque",
        "label": "Max torque",
        "value": 350,
        "unit": "Nm"
      }
    ],
    "options": [
      {
        "code": "P20",
        "name": "Winter package",
        "netPrice": null
      }
    ],
    "media": {
      "heroImageUrl": "https://media.example.com/tourer-0142.jpg",
      "imageCount": 12
    },
    "snapshot": {
      "id": "00000000-0000-4000-8000-000000000004",
      "capturedAt": "2026-11-02T09:13:53Z",
      "contentHash": "sha256:c610cda623428f95198b5943c9dca75a8acb8174a87584a3572796cb4b425ed1",
      "oemMarket": null,
      "oemEndpoint": null,
      "oemSchemaVersion": null
    }
  },
  "pricing": {
    "displayed": {
      "total": 38900,
      "currency": "EUR",
      "source": "atlas_price_offered"
    },
    "oem": {
      "grossPrice": null,
      "netPrice": null,
      "baseNetPrice": null,
      "taxes": [],
      "currency": null
    },
    "depositAmount": null,
    "depositRefundable": null,
    "paidTotal": null,
    "outstanding": null
  },
  "payment": {
    "paymentOutcome": "not_required",
    "orderStatus": null,
    "provider": null,
    "providerPaymentId": null,
    "paymentAttemptId": null,
    "rawStatus": null,
    "amount": null,
    "currency": null,
    "authorisedAt": null,
    "capturedAt": null,
    "refundedAt": null
  },
  "additionalFormFields": [
    {
      "name": "Preferred contact time",
      "value": "Weekday mornings"
    }
  ],
  "selections": {
    "purchaseType": null,
    "finance": null,
    "tradeIn": null,
    "tradeApplied": false,
    "services": [],
    "deliveryChoice": null,
    "raw": {}
  },
  "consent": {
    "privacyNoticePresented": true,
    "privacyNoticeVersion": "terms-v1",
    "termsAccepted": true,
    "termsAcceptedAt": "2026-11-02T09:13:52Z",
    "termsVersion": "terms-v1",
    "marketingEmailConsent": true,
    "marketingSmsConsent": null,
    "marketingWhatsappConsent": null,
    "thirdPartyTransferConsent": null
  },
  "links": {
    "buyerUrl": "https://app.architera.ai/d/example-motors/atlas/en/tourer-0142",
    "buildUrl": null,
    "adminUrl": "https://app.architera.ai/d/example-motors/leads/00000000-0000-4000-8000-000000000002"
  },
  "provider": {
    "name": "Example Motors",
    "service": "Atlas",
    "url": "https://app.architera.ai/d/example-motors/atlas"
  }
}
```

## What stays true

- **Inside v1, keys are only added.** Ignore keys you do not know. A breaking change becomes v2, with a dated retire table for v1.
- **Every change is dated** in the changelog of each connection.
- **Delivery is at least once.** Deduplicate on stable `event.id`, also sent as `webhook-id` on signed HTTPS deliveries, including Replay.
- **Errors have one shape:** RFC 9457, a stable `type` and a request id to quote to us.
- **Signing uses Standard Webhooks.** Production HTTPS delivery supports signing when configured; the sandbox uses only a public test secret. Generated OpenAPI 3.1 and JSON Schema 2020-12 downloads appear only when available.

**A refused call, as RFC 9457**

```
{
  "type": "https://developer.architera.ai/errors/invalid-key",
  "title": "Key not recognised",
  "status": 401,
  "detail": "Send a key in the Authorization header. Test keys start with alk_test_.",
  "requestId": "req_01JC8Q2M9T",
  "code": "invalid_key"
}
```
