1. Marketing Interface
  • autoX API Reference
    • Introduction
  • Marketing Interface
    • Overview
    • Lead Create
      POST
    • Appointment Create
      POST
    • Opportunity Create
      POST
    • Transaction Push⬩
      POST
    • Transaction Update⬩
      POST
  • Website Interface
    • Overview
    • Get Showroom List
      GET
    • Get Make Data
      GET
    • Get Model Data
      GET
    • Get Sales Org Data
      GET
    • Get Equipment Stock Data
      GET
    • Get Characteristics Data of Equipment
      GET
    • Get Material Addons Data
      GET
    • Get Bill Of Material Data
      GET
    • Get Equipment Price
      POST
    • Vehicle Enquiry Create
      POST
  • Payment Gateway Interface
    • Overview
    • Payment Link Create⬩
      POST
    • Payment Link Cancel⬩
      POST
    • Payment Notification
      POST
    • Payment Status Check⬩
      POST
  • Aftersales Interface
    • Overview
    • Check Workload Capacity
      POST
    • Service Request Push⬩
      POST
    • Get Parts Price & Stock
      POST
    • Work Estimate Create
      POST
    • Service Request Update⬩
      POST
  • Call Center Integration
    • Overview
    • Data Fetch
    • Transaction Sync
    • Queue Upload⬩
  • Survey Interface
    • Overview
    • Update Survey Score
  • OEM Interface
    • Overview
    • Accounts Data
    • Parts Sales Data
    • Parts Stock Data
    • Customer Data
    • Labour Sales Data
    • Vehicle Data
    • Vehicle Sales Data
    • Service History Data
    • Open Repair Orders Data
    • Open Repair Orders Customer Data
    • Workshop Transactions Data
    • Workshop Transactions Customer Data
    • Future Booking Data
  1. Marketing Interface

Transaction Push⬩

POST
⬩This is an outbound webhook.
Based on a configurable trigger or manual push, autoX will POST a transaction payload to a partner-provided endpoint to create the corresponding record in the external system. This supports pushing leads and opportunities created in autoX to external CRM or marketing platforms. The partner is responsible for implementing and hosting the endpoint that receives this payload. autoX expects a response containing the partner-assigned record ID to acknowledge receipt.

Request

Body Params application/json

Examples

Responses

🟢200
application/json
OK – Transaction received and created or updated successfully.
Bodyapplication/json

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transactionNumber": "0000010001",
    "transactionType": "Lead",
    "status": "Open",
    "SourceSystem": "ZSAP",
    "UtmCampaign": "CEM1234",
    "UtmMedium": "DEFR5",
    "UtmSource": "ABCD12",
    "CampaignId": "119513256",
    "Origin": "Z03",
    "createdDate": "2025-10-01T08:00:00.000Z",
    "modifiedDate": "2025-10-01T08:00:00.000Z",
    "dealerId": "DemoStore",
    "customer": {
        "externalId": "0010000001",
        "firstName": "John",
        "lastName": "Smith",
        "name": "John Smith",
        "emailAddresses": [
            "john.smith@example.com"
        ],
        "phones": [
            {
                "type": "Mobile",
                "number": "+971501234567"
            }
        ]
    },
    "vehicle": {
        "make": "MCLAREN",
        "model": "540C",
        "year": "2025",
        "color": "X37",
        "trim": "",
        "edition": "",
        "material": "MC540C03"
    },
    "salesArea": {
        "salesOrganization": "3000",
        "distributionChannel": "10",
        "division": "10",
        "salesOffice": "U311",
        "salesGroup": "003"
    }
}'
Response Response Example
200 - Success
{
    "id": "EXT-00012345",
    "externalId": "0000010001"
}
Previous
Opportunity Create
Next
Transaction Update⬩
Built with