Developer API
The GoAsk 3D Configurator can tell your own systems about every build and lead, and let them read the details whenever they need to. No per-app plugin is needed: anything that can make an HTTPS request or receive one can connect (a CRM, an ERP, Zapier, Make, or your integrator’s code).
| You want to | Use | Start here |
|---|---|---|
| Be told the moment something happens | Webhooks: we POST a signed event to your https URL | Webhooks |
| Read leads and builds, or catch up after downtime | Read API with an API key | Reading leads |
| Try it in ten minutes | Make a key, read your leads, receive a test webhook | Quickstart |
| Every field and response | The reference (OpenAPI 3.1) | API reference · openapi.yaml |
The pieces
Section titled “The pieces”- Your developer page. Keys and webhooks are made on your configurator’s own
/developerpage (for examplehttps://yourbrand.3dconfigurator.com.au/developer), signed in with your personal manufacturer account. A key or a webhook secret is shown once, when it is made; we keep only a hash of a key. - Base URL. Your configurator’s address. The key decides whose data you get.
- Customer details are off by default. A key or a webhook sees ids, the dealership, the vehicle, the parts (SKU, name, price), totals and status. Names, emails, mobiles, rego and salesperson are only included when you tick “Include customer details” for that key or webhook.
- Events:
lead.created,build.created(never a person),quote.sent,lead.won. - Limits: 120 requests a minute per key. Webhooks are retried for about 5 days.
Code you can copy
Section titled “Code you can copy”- sync-leads.mjs: keep your system in step with your leads (Node 18+).
- webhook-receiver.mjs: an endpoint that checks every delivery (Node 18+).
- verify_webhook.py: check a signature in Python (standard library only).
See the changelog for what changed and the versioning rules.