Webhooks

Webhooks allow you to send real-time notifications to external systems when specific events occur in LMI. When an application trigger fires, LMI automatically sends an HTTP request to your configured URL, enabling seamless integration with billing systems, workflow automation platforms, and other external services.

Overview

The Webhooks module allows you to:

• Register webhook URLs that receive notifications when specific events occur
• Configure connections to external billing and automation systems
• Enable real-time data synchronization with third-party platforms
• Link webhooks to External Systems for credential management
• Copy webhook URLs quickly for use in external configurations

Accessing Webhooks

Navigate to Settings → Data Integration → Webhooks from the sidebar menu.

Note

Access to Webhooks requires appropriate permissions. Contact your administrator if you don’t see this option in the menu.

Webhooks List

The main view displays all webhooks configured for your organization in a sortable table.

Table Columns

Column	Description
Name	The application trigger name. Click to open the edit panel.
Webhook URL	The destination URL where notifications are sent (truncated). Click to copy the full URL to clipboard.

Searching Webhooks

Use the search field in the header to filter webhooks by name or URL. Results update as you type.

Sorting

Click any column header to sort the list. Click again to reverse the sort order.

Registering a New Webhook

1. Click the dropdown menu (three dots) next to the page title
2. Select Register Webhook
3. Complete the required fields in the form
4. Click Save

Webhook Fields

Field	Required	Description
Application Trigger	Yes	The event type that triggers this webhook. Select from the available triggers (see Understanding Application Triggers).
Webhook URL	Yes	The destination URL where LMI sends the notification when the trigger fires. This is typically a webhook endpoint provided by your external system.

Tip

Before saving, verify your webhook URL by testing it in your external system. Most automation platforms provide a test or debug mode for webhook endpoints.

Editing a Webhook

1. Click on the webhook name in the list to open the edit panel
2. Modify the desired fields
3. Click Save to apply changes

All fields except the webhook ID can be modified. Changes take effect immediately after saving.

Caution

Modifying a webhook URL will immediately redirect notifications to the new destination. Ensure your new endpoint is ready to receive data before saving changes.

Understanding Application Triggers

Application triggers define which events in LMI cause a webhook notification to be sent. Each trigger corresponds to a specific system event.

Available Triggers

Trigger	Description	When It Fires
Financial E-Check Processed	Notifies external systems when e-check payments are processed	After an ACH/EFT payment batch is submitted for processing
Optimization Solution Updated	Sends route optimization results to external systems	When the route optimization engine completes a solution
Task Operations	Triggers workflows based on task lifecycle events	When tasks are created, updated, or status changes occur

Payload Format

When a trigger fires, LMI sends an HTTP POST request to the configured webhook URL. The request includes:

• Content-Type: application/json
• Authorization: Bearer token (if configured via linked External System)
• Body: JSON payload containing event-specific data

The exact payload structure varies by trigger type. Work with your integration team to configure your external system to handle the expected data format.

Relationships

Webhooks can optionally link to External Systems, which provide credential storage and organizational context for your integrations.

┌─────────────────────────────────────────────────────────────┐
│                     External System                          │
│  (n8n, Make, Zapier, Billing Platform)                      │
│                                                              │
│  - API URL                                                   │
│  - API Token / Credentials                                   │
└─────────────────────────────────────────────────────────────┘
                           │
                           │ provides credentials to
                           ▼
┌─────────────────────────────────────────────────────────────┐
│                        Webhook                               │
│                                                              │
│  - Application Trigger (event type)                          │
│  - Webhook URL (destination)                                 │
│  - External System ID (optional)                             │
└─────────────────────────────────────────────────────────────┘
                           │
                           │ sends notifications to
                           ▼
┌─────────────────────────────────────────────────────────────┐
│                   External Endpoint                          │
│                                                              │
│  Receives HTTP POST with event data                          │
└─────────────────────────────────────────────────────────────┘

Related Features

• External Systems — Configure the external platforms that webhooks connect to, including credentials
• Adapters — Bi-directional automation connectors (webhooks are unidirectional outbound)
• Subscriptions — Subscribe to specific events for automated processing

Webhooks vs Adapters

Feature	Webhooks	Adapters
Direction	Outbound only	Bi-directional
Purpose	Event notifications	Automation connectors
Trigger	Predefined application events	Custom automation events
API Access	Not available	Optional inbound API endpoint

Use Webhooks when you need to notify an external system about specific application events (like payment processing or optimization updates). Use Adapters when you need more complex automation with potential inbound requests.

Best Practices

1. Test URLs before production — Verify your webhook endpoint works correctly in a test environment. Use your external platform’s debugging tools to confirm requests are received and processed.

2. Use External Systems for credentials — When your webhook endpoint requires authentication, configure the credentials in an External System and link it to the webhook. This centralizes credential management.

3. Monitor webhook delivery — Set up logging or monitoring in your external system to track webhook deliveries. This helps identify issues quickly when notifications stop arriving.

4. Document your integrations — Keep records of which webhooks connect to which external systems, what data they send, and how the external system processes them.

5. Plan for failures — External systems may be temporarily unavailable. Consider how your external platform handles missed webhook notifications and whether retry logic is needed.

Troubleshooting

Webhook not triggering

Possible Cause	Solution
Trigger event not occurring	Verify the application event that should trigger the webhook is actually happening (e.g., confirm a payment was submitted, optimization ran).
Webhook not registered	Check that a webhook exists for the expected trigger type in the Webhooks list.
Incorrect trigger selected	Verify the webhook is configured with the correct Application Trigger for your use case.

External system not receiving data

Possible Cause	Solution
Incorrect webhook URL	Verify the URL is correct. Copy it from your external system and paste it exactly.
External system offline	Check that your external platform is running and the endpoint is accessible.
Network/firewall issues	Ensure LMI can reach your external endpoint. Check firewall rules if hosted on-premises.
URL requires authentication	If your endpoint requires authentication, configure credentials in an External System and link it to the webhook.

Webhook URL copy not working

Possible Cause	Solution
Browser permissions	Ensure your browser allows clipboard access. Try clicking the URL itself or the copy icon.
URL truncated in display	The full URL is copied even if truncated in the table. Paste it to verify the complete URL was copied.

Cannot save webhook

Possible Cause	Solution
Application Trigger not selected	Select a trigger type from the dropdown.
Webhook URL empty	Enter a valid webhook URL.
Invalid URL format	Verify the URL starts with http:// or https:// and is properly formatted.