Skip to main content

Deployment Status

Understand how the Admin Dashboard monitors FinMatch snippet deployment across merchant websites.

How Deployment Status Works​

The Deployment column in the merchants table shows whether the FinMatch snippet is actually deployed on each merchant's website. This is checked in real-time by automatically crawling merchant websites.

The Process​

  1. On Page Load - When you visit the merchants page, the dashboard automatically checks deployment status for all merchants
  2. API Call - For each merchant with a domain, the dashboard calls the Merchant API endpoint: /api/merchants/:id/deployment-status
  3. Website Crawl - The Merchant API calls a Cloud Function (monitor) that crawls the merchant's website
  4. Snippet Detection - The monitor function checks if the FinMatch snippet is present on the page
  5. Status Update - The deployment status is updated in the merchant profile and displayed in the table

Status Values​

StatusMeaningBadge Color
DeployedFinMatch snippet is active and found on the websiteGreen
UnknownStatus not yet checked, snippet not found, or site unreachableGray
Real-time Checking

Deployment status is checked every time you load the merchants page. Checks run with 1-second delays between requests to avoid rate limits.

Understanding the Results​

Deployed​

  • The FinMatch snippet was found on the merchant's website
  • The snippet is active (not commented out)
  • The merchant's website is reachable

Unknown​

This status can mean:

  • The status hasn't been checked yet (first time loading)
  • The FinMatch snippet was not found on the website
  • The merchant's website is unreachable or returns an error
  • The merchant doesn't have a domain configured

Status Column vs Deployment Column​

The merchants table has two different status columns:

Status Column​

  • Shows merchant account status (Active, Pending, Suspended)
  • Related to account activation or billing status
  • Typically set manually or by system processes

Deployment Column​

  • Shows FinMatch snippet deployment status (Deployed, Unknown)
  • Checked automatically by crawling merchant websites
  • Updated in real-time on page load
tip

If a merchant shows "Pending" in Status but "Deployed" in Deployment, it means their account is pending activation but the snippet is already deployed on their website.

Manual Status Refresh​

The deployment status is automatically refreshed when you:

  • Load the merchants page
  • Navigate away and return to the merchants page
  • Refresh the browser page

You don't need to manually trigger a refresh - it happens automatically.

Troubleshooting​

All Merchants Show "Unknown"​

  • Check that the Merchant API is running and accessible
  • Verify that the monitor Cloud Function is deployed and working
  • Check browser console for API errors

Specific Merchant Shows "Unknown"​

  • Verify the merchant has a domain configured
  • Check if the domain is accessible (try visiting it in a browser)
  • Ensure the FinMatch snippet is actually deployed on the website
  • Check if the website has any blocking mechanisms (CORS, robots.txt, etc.)

Status Not Updating​

  • Clear browser cache and reload
  • Check network tab in browser dev tools for API call failures
  • Verify Merchant API logs for errors

Technical Details​

API Endpoint​

GET /api/merchants/:id/deployment-status

Response Format​

{
  "success": true,
  "status": "deployed",
  "details": "Active script found",
  "timestamp": "2025-01-15T10:30:00Z"
}

Monitor Function​

The deployment check uses a Cloud Function that:

  • Fetches the merchant's website HTML
  • Searches for FinMatch snippet patterns
  • Detects if the snippet is active or commented out
  • Returns the environment detected (Production, Staging, Test, or Not Found)

Next Steps​