Step-by-Step Guide: How to Configure a Webhook in Meritto?

Step-by-Step Guide: How to Configure a Webhook in Meritto?

Overview

This guide shows the exact steps to create and configure a webhook in Meritto so external systems receive lead, application, opportunity or dynamic activity data in real time via HTTP POST (JSON). It covers permissions, prerequisites, JSON configuration, advanced transformation settings, authentication, file delivery options, testing, and monitoring.

Plan & Permissions (pre-check)

  1. Ensure Webhook add-on is Subscribed for your institute.
  2. Required permissions:
    1. View Webhook: Post Application Manager > ERP Manager
    2. Create / Edit Webhooks: Post Application Manager > Configure ERP
    3. View push logs: API/Integration Logs

Pre-requisites 

Basic (required)
  1. Valid API endpoint on the receiving system that accepts POST requests.
  2. Trigger identification: know which Meritto event will initiate the push (e.g., Application Submit, Lead Verified, Payment Approved).
  3. Form / Program mapping: decide which form or opportunity this webhook applies to.
  4. Payload format: confirm the receiving system accepts JSON and the expected JSON structure (simple, nested, array).
  5. Authentication credentials (if endpoint is secured): Basic Auth / Bearer Token / Custom Header Token.
Advanced (only if applicable)
  1. Document transfer method (if sending uploaded documents): Full URL, SFTP or Amazon S3 and required credentials.
  2. Custom file naming rules (e.g., AppNo_Transcript.pdf) if the receiver needs them.
  3. Two-step API flow details if the receiver requires session tokens (Step 1 — fetch token; Step 2 — use token).

Step-by-step Guide to Create & Configure a Webhook

Step 1 — Create the Webhook

  1. Navigate: Post Application > Webhook.
  2. Click Create.
  3. Fill basic details:
    1. Webhook Name
    2. College Name (select)
    3. Form Name (select)
    4. Module: Lead / Application / Opportunity / Dynamic Activity (As per your subscription)
    5. Trigger Event (choose the exact event)
    6. Vendor: Select Other and enter vendor name
  4. Webhook Listing Page : Click on the “+ New Webhook” Button to create a New Webhook. 



Step 2 — Configure Webhook JSON (payload)

  1. Webhook transfers data in JSON.
  2. Use the token picker to insert field tokens (tokens are populated based on the module selected in Step 1).
  3. Build the JSON template. Example:

    {

      "name": "{{ud.name|Registered Name}}",

      "email": "{{u.email|Registered Email}}"

    }


  4. Click Validate JSON to ensure formatting is correct.

Step 3 — Advanced Settings (transformations & rules)

  1. Use these only as required by the receiving system:
  2. Required Field Configuration — mark fields mandatory; if blank, webhook call will fail.
  3. Date Fields Configuration — convert/format dates (e.g., DD/MM/YYYY, YYYY-MM-DD).
  4. Replace Value Field Configuration — map values to replacements (format: {"Field Value":"Replaced Value"}).
  5. Default Value Field Configuration — set fallback values for empty fields.
  6. Yes/No Field Configuration — standardize checkbox/boolean outputs (Yes/No, 1/0).
  7. Split Data Field Configuration — split a field by separator and send the required part (e.g., dial code separate from mobile).
  8. Conditional Filter Configuration — only trigger webhook if condition(s) are met (e.g., Program = MBA).
  9. Integer Field Configuration — convert text to integer.
  10. File Field Configuration — define file upload paths and method for upload-type fields (SFTP, Amazon S3, Full URL).

Step 4 — Configure Request & Authentication - In details 

Select the Method of API Configuration - Single Step or Two Step
  1. Single Step 
    1. Configure Sandbox / Production mode as applicable.
    2. Request method: choose POST.k
    3. Content Type : Application JSON
    4. Request URL : 3rd Party System API URL
    5. You can also add Parameters like (Headers and Body) in this by clicking on Add request parameters. 
    6. Response Type : Select the Response Type 
    7. Mark Success : You can configure the key and the value based on which you want to mark success inside meritto. 
  2. Two Step 
    1. Configure Sandbox / Production mode as applicable.
    2. Request method: choose POST.
    3. Content Type : Application JSON
    4. Request URL : 3rd Party System API URL (For Fetching Token) 
    5. You can also add Parameters like (Headers and Body) in this by clicking on Add request parameters. 
    6. Response Type : Select the Response Type 
    7. Request URL 2 - 3rd Party System API URL (For Posting Data)
    8. Use the “Bearer Token” Fetched from the 1st API to be used in the 2nd API by adding the same in Parameters 
    9. Response Type : Select the Response Type 
    10. Mark Success : You can configure the key and the value based on which you want to mark success inside meritto. 

Step 5 — Configure File Uploads (if sending documents)

Options supported:
  1. Full URL — send file links in payload.
  2. SFTP — configure host, path, credentials.
  3. Amazon S3 — configure bucket, folder, access credentials.
  4. Configure custom file naming logic here if required.

Step 6 — Preview & Test

  1. Use Test Hit to send a sample payload.
  2. Confirm a real record that meets trigger conditions is used for testing (valid lead/application/opportunity/dynamic activity).
  3. Verify the receiving endpoint response and ensure success conditions are satisfied.

Step 7 — Save & Activate

  1. Once JSON, advanced settings, auth, and uploads are validated, Save the webhook.
  2. Activate / enable it for production 

Step 8 — Monitor Logs & Activity

  1. Check API/Integration Logs for success/failure details.
  2. Logs are retained for review for up to 10 days.
  3. Use logs to confirm successful delivery or inspect failure reasons.

Points to Keep in Mind

  1. Always Validate JSON before saving.
  2. Vendors must provide API documentation (endpoints, expected success response, auth requirements, file expectations) for the integration to be done seamlessly and avoid any error during the data export. 
  3. Confirm whether the third party expects a particular success response format—map that in your request/response parsing.
  4. Use transformations (date, replace, default) only to match the vendor’s required format.
  5. Review logs within the 10-day window for troubleshooting.

Conclusion

Follow the exact numbered steps above to create and deploy a webhook in Meritto. The flow covers creation, JSON configuration, advanced field transformations, authentication (single- and two-step), file delivery options, timeout and retry behavior, testing, and monitoring — using only the details you provided.

    • Related Articles

    • Connecting Facebook Lead Ad Form with Meritto

      Introduction Facebook Ads (also known as Instant Forms) provide a seamless way for users to express interest in your offerings by submitting a form directly on Facebook or Instagram, without ever having to leave the platform. These forms are widely ...

    • How to Push Bulk Webhook?

      Overview Bulk Webhook Push in Webhook Manager enables users to resend lead and application data efficiently by retriggering existing webhook logic. Recover & Resend Data: Resolve failed webhook notifications or transmission issues. Bulk Repush: ...

    • How to Identify and configure GTM Code in Meritto?

      Overview Google Tag Manager (GTM) is a tag management system that enables you to deploy and manage multiple tracking scripts from a centralized container, eliminating the need for direct code modifications on your website. It acts as a central ...

    • CTA (Call-to-Action) Whitelisting Process for SMS: A Step-by-Step Guide

      Overview In today’s digital communication landscape, SMS continues to be a powerful channel for customer engagement. However, with growing regulatory scrutiny and evolving user data protection laws, it's crucial to follow proper protocols — ...

    • How to Configure Token Fee?

      Overview Token Fee configuration in Meritto allows institutions to collect an initial payment from applicants before proceeding with further steps. This article provides a step-by-step guide to setting up a Token Fee in Meritto. Plan & Permissions ...