Webhook Module in Meritto

Webhook Module in Meritto

Overview

The Webhook module in Meritto is a real-time integration tool that allows lead, application, and opportunity data to be shared automatically with external systems. It eliminates the need for manual exports and ensures that your CRM, ERP, or other connected platforms stay updated when key events occur, such as application submission, payment approval, or lead verification.

Whenever one of these events takes place, Meritto sends structured data instantly to your configured API endpoint, enabling automation, accuracy, and operational speed.

Plan & Permissions

Availability:
Webhook is offered as an Add-on, available across all Meritto plans.

Permissions Required:

  • To view and access the Webhook module: ERP Manager (under Post Application Manager)

  • To configure webhooksConfigure ERP (under Post Application Manager)

Pre-Requisites

Before configuring a webhook, ensure the following conditions are met based on your integration scope.

Basic Prerequisites (Essential for Any Webhook Setup)

  1. Valid API Endpoint
    The external system must provide an active API endpoint that accepts POST requests.

  2. Trigger Identification
    Decide which event in Meritto will initiate the webhook (e.g., Application Submit, Lead Verified, Payment Approved).

  3. Form or Program Mapping
    Identify which form(s) or Opportunity(s) the webhook should apply to, if applicable.

  4. Payload Format
    The external system must support receiving data in JSON format. The required structure (simple, nested, array) should be confirmed in advance.

  5. Authentication Setup (if required)
    Prepare credentials if the receiving endpoint is secured. Supported authentication methods include:

    • Basic Auth (username/password)

    • Bearer Token

    • Custom Header Token

Advanced Prerequisites (For Document Transfers and Data Configuration)

  1. Document Handling Setup (if needed)
    If the integration includes candidate-uploaded documents, decide the method of delivery:

    • Direct URL (file shared as a link)

    • FTP / SFTP (standard or v4+)

    • Amazon S3 (requires access credentials and bucket details)

  2. Custom File Naming Logic
    If required by the external system, define how files should be named (e.g., AppNo_Transcript.pdf).

  3. Two-Step API Configuration
    For systems requiring session tokens:

    • Step 1: Fetch the token

    • Step 2: Use the token in the header or body of the main data push

  4. Data Transformation Rules
    To meet formatting or validation standards of the external system, transformations can be configured:

    • Required Field Validation: Block request if key fields are empty

    • Date Format Conversion: Format dates to DD/MM/YYYY, YYYY-MM-DD, etc.

    • Value Replacement: Convert system values (e.g., “MALE” to “M”)

    • Default Values: Insert fallback values where data is missing

    • Yes/No Formatting: Standardize Boolean fields (Yes/No, 1/0)

    • Field Splitting: Divide a full name or concatenated value into separate fields

    • Conditional Filters: Only send data when specific conditions are met (e.g., Program = MBA)

    • Integer Field Checks: Enforce numeric values where applicable

  5. Error Handling Expectations
    Clarify if the receiving system requires a specific success response or format to confirm delivery.

Core Functionalities

Supported Trigger Events

Webhook triggers can be configured on the following events:

Lead Module

  • Lead Verified

  • Lead Unverified

  • Lead Verified-Unverified Both

  • Lead Update

  • On Request

  • Lead Owner Update

Application & Payments Module

  • Application Initiate

  • Application Stage 

  • Application Submit

  • Application Update

  • Partwise Submit

  • Payment Approved

  • Token Fees

Opportunity Module

  • Opportunity Create

  • Opportunity Stage

Dynamic Activity Triggers

  • Dynamic Activity Create

  • Dynamic Activity Update

Supported Payload Structures

Webhooks support flexible data formats, depending on what your external system accepts:

  • Simple JSON:
    { "name": "John", "age": 25 }

  • Nested JSON:
    { "user": { "id": 101, "profile": { "name": "John", "dept": "Engineering" }}}

Request and Response Handling

Single-Step Integration

Used when one direct POST request is enough. You can define:

  • Endpoint URL

  • HTTP method

  • Sandbox or Production mode

  • Expected response format (JSON, XML)

Two-Step Integration

Used for APIs requiring authentication or tokens.

  • Step 1: Fetch token (Bearer Token) 

  • Step 2: Use the token in the final data push
    Both steps can be customized with field mapping and response parsing.

File Upload Support

If documents need to be sent as part of the webhook, you can configure one of the following file upload methods:

  • Full URL – Share file links directly

  • FTP / SFTP / SFTP v4+ – Push files using secured credentials

  • Amazon S3 – Place files in specified folders within an S3 bucket

Each upload supports custom file naming to ensure compatibility with the receiving system.

Retry Mechanism

To ensure reliability:

  • Fallback Retry (Every 30 Minutes):
    If the real-time push fails due to internal issues, the system retries in the next cycle automatically.

  • 3rd Party Error Retry (2:00 AM):
    If the external API does not respond successfully, Meritto retries the same data the next day at 2:00 AM.

  • Logs and Monitoring:
    All webhook activity (success/failure) is logged and available for review in API logs for up to 10 days.

Timeout Policy

To ensure that requests are processed quickly and efficiently, a 10-second response timeout has been implemented in the webhook.

This means any webhook request sent from Meritto will wait for the 3rd-party API's response for up to 10 seconds. If the 3rd-party API does not respond within this time, the webhook request will be marked as failed and retried according to the Retry Mechanism.

 

Benefits of the Webhook Module

  • Real-time data sync for lead, application, and payment activity

  • Reduces manual operations and dependency on exports

  • Highly configurable with filters, transformation, and mapping

  • Secures document delivery through SFTP, S3, or URLs

  • Flexible for simple or multi-step API integrations

  • Prevents data loss with built-in retries

  • Easy access to webhook logs for traceability

Special Business Use Cases

  • Instant CRM updates when leads are verified

  • Real-time ERP sync with submitted applications and approved payments

  • Automated document sharing with external agencies

  • Token-authenticated API integrations with session-based flows

Conclusion

The Webhook module in Meritto is a complete real-time integration system designed to connect your internal data with external platforms in a structured and reliable way. With support for flexible formats, secure document transfer, fallback retries, and configurable conditions, it enables scalable automation for institutions managing large volumes of application and lead data.

    • Related Articles

    • Dynamic Activity Create Trigger in Webhook Module

      Overview The Dynamic Activity Create Trigger is a webhook trigger that activates in real time whenever a new dynamic activity is created against any lead or opportunity. This includes activity creation from the API, Lead/Opportunity profile, or the ...
    • Application Stage Changed Trigger in Webhook Module

      Overview This is a Webhook-integrated trigger that activates as soon as an application's stage is changed, regardless of the form type or payment state. The system pushes all configured stage-change entries in real time from Meritto to the configured ...
    • Application Submit Trigger in Webhook Module

      Overview The Application Submitted Trigger is a Webhook Trigger that activates in real time whenever an application is submitted through any form type (excluding partwise forms). This ensures that client systems receive timely and consistent data, ...
    • Token Fees Trigger in Webhook Module

      Overview This is a Webhook-integrated trigger that activates as soon as a candidate pays the configured Token fees. The system pushes all payment-approved entries in real time from Meritto to the configured Third-Party API Endpoint (set up in ...
    • Partwise Submit Trigger in Webhook Module

      Overview The Partwise Submit Trigger is a Webhook Trigger that activates in real time whenever a candidate saves and submits a section (part) of an application form. Unlike the full application submission trigger, this one ensures that client systems ...