Documentation / Integrations & API / Webhooks & Event Notifications

Webhooks & Event Notifications

Webhooks & Event Notifications

Webhooks allow external systems to receive real-time notifications when events occur in the DMS system.

What are Webhooks?

Webhooks are HTTP callbacks that send data to a specified URL when events occur:

  • Real-time notifications
  • Automatic data synchronisation
  • Trigger external processes
  • No polling required

Available Events

Configure webhooks for these events:

  • Vehicle Events:
    • Vehicle added to inventory
    • Vehicle status changed
    • Vehicle sold
  • Deal Events:
    • New enquiry created
    • Deal created
    • Deal status changed
    • Deal completed
  • Job Events:
    • Job created
    • Job invoiced
    • Job completed
  • Customer Events:
    • New customer created
    • Customer updated

Configuring Webhooks

To set up a webhook:

  1. Navigate to: System Administration / Integrations / Webhooks
  2. Click "Create Webhook"
  3. Enter webhook details:
    • Webhook name
    • Target URL (endpoint to receive notifications)
    • Select events to subscribe to
    • HTTP method (POST recommended)
  4. Configure authentication (if required)
  5. Test webhook
  6. Enable webhook

Webhook Payload

Webhook payloads include:

  • Event type
  • Event timestamp
  • Related data (vehicle, deal, job, etc.)
  • User who triggered the event

Webhook Security

Secure your webhooks:

  • HTTPS Only: Use secure connections
  • Signature Verification: Verify webhook signatures
  • IP Whitelisting: Restrict to known IPs
  • Authentication: Use API keys or tokens

Webhook Retry Logic

Failed webhook deliveries are retried:

  • Automatic retry on failure
  • Exponential backoff
  • Maximum retry attempts
  • Failure notifications

Testing Webhooks

Test your webhook configuration:

  • Send test event
  • Verify payload format
  • Check response handling
  • Monitor webhook logs

Webhook Logs

Monitor webhook activity:

  • View all webhook deliveries
  • See success/failure status
  • View payloads sent
  • Check response codes
  • Debug failed deliveries

Best Practices

  • Use HTTPS for all webhooks
  • Implement idempotency
  • Handle errors gracefully
  • Log all webhook activity
  • Monitor webhook health

Related Articles

API Overview & Authentication

Introduction to the NexosOne DMS API, authentication, and getting started

Third-Party Integrations

Guide to integrating with external systems, accounting software, and third-party services