Webhooks User Guide

Objectives:

• Automated HTTPS POST Requests for System Integration: Configuration and Usage of Web hooks

Steps:

1- Overview

Web hooks allow the system to send an HTTPS POST request automatically whenever specific triggers are activated. This feature helps in integrating external systems or automating workflows based on real-time changes.

2- Triggers for Web hooks

A web hook is triggered when one of the following actions occurs:

• Matters:

  • Adding a Matter
  • Editing a Matter
  • Updating Workflow Status

• Intellectual Properties:

  • Adding Intellectual Properties
  • Editing Intellectual Properties 

• Matter Containers:

  • Adding Matter Containers
  • Editing Matter Containers

• Contracts:

  • Adding a Contract
  • Editing a Contract
  • Updating Workflow Status

3- How It Works

• When an event (e.g., adding a new contract) occurs, the system automatically sends an HTTPS POST request to a predefined endpoint
• The system supports sending web hooks to two different endpoints, allowing integration with multiple external systems simultaneously
• The request contains relevant data about the action performed
• External systems receiving the web hook can process the data for further automation or synchronization

4- Use Cases

• Real-time Notifications: Notify external services when a new contract/matter is added
• Data Synchronization: Keep external databases updated with the latest matter/contract changes
• Workflow Automation: Trigger actions in third-party applications when a workflow status is updated

5- Configuration

To set up web hooks, you need to:

1. Define the primary endpoint URL where web hook data should be sent
2. (Optional) Define a secondary endpoint URL if data needs to be sent to a second system
3. Ensure both receiving systems can process HTTPS POST requests
4. Test the web hook by performing a trigger action and verifying the responses from both endpoint

For more information about LEXZUR, kindly reach out to us at help@lexzur.com.

Thank you!