SBT Webhook

Note

A webhook is not required when using SBT 2.0.

Installation

Step 1

Download and install the latest .NET 5 ASP.NET Core Runtime & Hosting Bundle for Windows.

Step 2

Copy the sbtwebhook folder to the IIS root folder (typically C:\inetpub\wwwroot\).

For NLS 5.39 and later, please contact Nortridge Support to obtain the required SBT webhook files.

For NLS versions prior to 5.39, the sbtwebhook folder is installed during the Nortridge Client installation and is located at c:\Program Files (x86)\Nortridge Software\NLS\sbtwebhook.

Step 3

Open the appsettings.json file with a text editor.

Note

The text editor may need to be run as administrator to allow it to save the file.

The unedited file should look like this:

Unedited appsettings.json

{
    "ConnectionStrings": {
        "Default": {
            "ConnectionString": "",
            "Type": ""
        }
    },
    "Logging": {
        "LogLevel": {
            "Default": "Warning"
        }
    },
    "AllowedHosts": "*"
}

For Microsoft SQL Server, add the following to the ConnectionString parameter where:

  • Data Source = name of the database server;
  • Initial Catalog = name of the database;
  • User Id = username for the database;
  • Password = password for username;

Set Type to MSSQL.

MSSQL appsettings.json

{
    "ConnectionStrings": {
        "Default": {
            "ConnectionString": "Data Source=SERVER_NAME; Initial Catalog=DATABASE_NAME; User Id=DATABASE_USERNAME; Password=DATABASE_PASSWORD",
            "Type": "MSSQL"
        }
    },
    "Logging": {
        "LogLevel": {
            "Default": "Warning"
        }
    },
    "AllowedHosts": "*"
}

For Oracle, add the following to the ConnectionString parameter where:

  • User ID = username for the database;
  • Password = password for username;
  • Data Source = Oracle TNS format or TNS alias;

Set Type to ORACLE.

Oracle appsettings.json

{
    "ConnectionStrings": {
        "Default": {
            "ConnectionString": "User ID=DATABASE_USERNAME; Password=DATABASE_PASSWORD; Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=SERVER_NAME)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=ORACLE_SERVICE_NAME)))",
            "Type": "ORACLE"
        }
    },
    "Logging": {
        "LogLevel": {
            "Default": "Warning"
        }
    },
    "AllowedHosts": "*"
}

Save the changes.

Step 4

Open the Internet Information Service (IIS) Manager application. Right click on the Connections pane and select Add Website….

Enter the site name and specify the physical path to the sbtwebhook folder.

Click Connect as… and specify credentials to use if needed.

sbt webhook

Step 5

Go to Application Pools and select sbtwebhook. Click Advanced Settings… and set .NET CLR Version to No Managed Code and Start Mode to AlwaysRunning.

sbt webhook

Step 6

Open http://localhost/version in your web browser to verify that the webhook is running.

sbt webhook

The computer running the webhook must be publicly available and accessible from the Internet. Replace localhost with the IP number or domain name of where the computer is located and check that it can be accessed from outside your network.

Step 7

Before the URL can be used, append “/messages” to the web address. The URL should now be in the form of:

https://<IIS-website-path>/messages

where <IIS-website-path> in this example is localhost.

This is your Callback URL and it will need to be provided to SBT to finish the configuration.

In your SBT portal the Org Code in the Details tab should match with the Callback URL in the Custom Info tab.

NLS 5.39 and later

To switch to SBT 2.0 from SBT 1.0, append “/V2/messages” to the callback URL. This will instruct the webhook to use SBT 2.0 instead of SBT 1.0 when communicating with SBT. The URL for SBT 2.0 should be in the form of:

https://<IIS-website-path>/V2/messages

SBT 2.0 configuration is in Setup > System > Web Services.