App Documentation

Netlify Function: incomingWebhook.js

This function serves as the main entry point for handling incoming webhooks.

Main Handler

The main exported handler in this function does the following:

• Validates the webhook payload using validateWebhookPayload
• Saves the validated webhook using saveWebhook
• Processes the events within the webhook payload using processEvents
• Returns a response indicating the successful receipt of the webhook along with any payloads processed

Utility Functions

• response: Constructs a response object given a status code and body.
• validateWebhookPayload: Validates the provided webhook payload, ensuring it's properly formatted as JSON. Returns parsed JSON or null if invalid.
• processEvents: Processes each event in the provided events array. This involves:
  • Fetching data associated with a loan code.
  • Sending borrower info, referral info, and deal info to GoHighLevel.
• getDealData: Fetches deal data from the Velocity API given specific parameters, specifically a loan code.

Dependencies

The function makes use of the following dependencies:

• axios - For making HTTP requests.
• dotenv - For loading environment variables.

Backend Functions

This main function relies on a couple of backend utility functions imported from other modules:

• saveWebhook - Saves the webhook data. The specific logic of this function isn't detailed in the provided code.
• ghHandler - A collection of methods for sending specific sets of data to GoHighLevel.

Function: saveWebhook.js

This function is responsible for saving the incoming webhook data to an AWS S3 bucket.

Workflow

• Parse the incoming data to extract relevant details such as the loanCode and the timestamp.
• Construct a filename using the loanCode and timestamp.
• Save the raw string data of the webhook as a JSON file to the AWS S3 bucket under the folder 'velocity_webhooks'.

Dependencies

The function leverages the following modules:

• AWS - For interfacing with AWS services, specifically S3.
• path - For handling and manipulating file paths.
• dotenv - For loading environment variables.

Environment Variables

The function utilizes the following environment variables:

• S3_ACCESS_KEY_Id: AWS S3 access key ID.
• S3_SECRET_KEY: AWS S3 secret key for authentication.

Output

Upon successful storage of the webhook data into the S3 bucket, the function returns a success message with a 200 status code, indicating the filename where the data was stored. If there is an error during the process, it logs the error and returns a 500 status code with an error message.