Glossary

Terms are in alphabetical order.

API. A set of fixed rules that lets one computer system talk to another.

Automatic file upload. The route where your system makes the daily Excel file and uploads it with a signature.

Automatic sending. The route where your system sends each lead event to MarsX as it happens.

Base64. A way to write binary data, such as a signature, using only letters, digits and a few symbols, so it can travel as text.

Catch-up check. MarsX’s scheduled, read-only check that finds events an automatic send missed. The contract calls it reconciliation. MarsX only reads. It never writes to your system.

Connection. One link between MarsX and one source, for one brand. MarsX identifies it by an opaque reference such as conn_exampleexample22. A connection has its own keys, credentials, cursors and lead IDs. Credentials from one connection fail on another.

Cursor. A marker that tells an API where the last page of results stopped. You give it back to get the next page.

ed25519. A modern signature method with a private key and a public key. You keep the private key. MarsX holds only the public key. It is scheme v1a.

Envelope. The outer JSON object of an event, with type, timestamp and data.

Event. One change to one lead, sent as one request. The four kinds are lead.new, lead.update, lead.withdraw and lead.delete.

File-fed. A connection that sends template files and not automatic sending events. MarsX shows it as file-fed, never as real time.

Header. A labelled line that travels with a web request, before the body. The signing headers start with webhook-.

HMAC-SHA256. A way to make a fingerprint of a message with a shared secret. Both sides hold the secret. It is scheme v1.

HTTPS and TLS. The secure way web traffic travels. MarsX accepts only HTTPS with TLS 1.2 or higher.

Inbox. The safe store where MarsX puts a verified event before it answers 202.

JSON. A plain-text format for structured data, written with braces and quoted names.

Lead. A customer enquiry about a vehicle, as one record.

OAuth client credentials. A standard way for one system to get a short-lived access token by showing an ID and a secret. MarsX uses it to read your endpoints, and you use it to read the event status.

Partner code. A short label that MarsX issues to each source. It is not the identity of a connection. It appears in file names.

partner_lead_id. Your stable ID for a lead within one connection. Never reused.

Pending restriction. A restriction that MarsX places on a lead when it stores a lead.withdraw or lead.delete, before the background worker has processed it.

Privacy marker. A flag on a lead that says personal data is restricted. A later update cannot clear it.

Incomplete lead. A lead that MarsX accepted without a model or a city. It is marked incomplete and is not set aside. A lead with no model, no city and no preferred dealer goes to a MarsX triage queue.

Problem details. The standard JSON format for errors (RFC 9457).

Processing state. What the worker decided about one event: queued, applied, ignored_stale_revision, ignored_duplicate_content or quarantined.

Quarantine. To store a record without applying it, and hold it for review.

Revision. See source_revision.

Sandbox. A test copy of the service with made-up data only. Events sent to it never reach dealers.

Signature. A short piece of text that only the holder of a secret can produce. MarsX checks it to confirm a request came from you and was not changed.

Source. The place a lead starts, such as a website chat, a web form, a marketplace or an ad platform, and the system that sends it to MarsX.

source_revision. A whole number that goes up with every change to a lead. It decides the order of changes. On a new lead it may be left out, and MarsX uses 1.

Standard Webhooks. An open specification for signing and sending messages from one system to another. MarsX follows version 1.0.0.

Technical contact. The person at your company who deals with MarsX. MarsX sends keys and results to this person.

Upload by staff. The route where named people on your team fill in the Excel template and upload it in a MarsX upload account.

UTC offset. The number of hours a local time differs from UTC, for example +07:00. Every date-time carries one. MarsX stores the instant and shows WIB.

Webhook. A message that one system sends to another when something happens.

webhook-id. The ID of one event. The same on every retry. It removes repeated deliveries and does nothing else.

WIB. Western Indonesia Time, UTC plus 7 hours.

Worked example. A set of made-up inputs with the exact result they must give. You use it to prove that your signing code is right.

Worker. The MarsX background process that takes events from the inbox and applies them.