Webhook integrations

Go to the IFTTT website and log in with your IFTTT credentials.

Create a new Applet: https://ifttt.com/create

Set up the If This part:

1. Click If This

2. Search for Webhooks

3. Click the blue Webhooks tile

4. Click Receive a web request with a JSON payload

5. Click Connect

6. Write xprotect_test in Event Name

7. Click Create trigger

Set up the Then That part:

1. Click Then That

2. Search Gmail

3. Click the blue Gmail tile

4. Click Send yourself an email

5. Click Connect

6. Click Create action

Click Continue

Click Finish

Go to https://ifttt.com/maker_webhooks

Click Documentation

Identify your URL. The URL should be something similar to: https://maker.ifttt.com/trigger/{event}/json/with/key/lPY4YYsvGSfTSJBM54MrDDSOGWTmk6z9VSD113hxoDY

Replace {event} with xprotect_test. The URL should end up similar to: https://maker.ifttt.com/trigger/xprotect_test/json/with/key/lPY4YYsvGSfTSJBM54MrDDSOGWTmk6z9VSD113hxoDY

Copy and save this address. The address should not be shared with unauthorized users.

In Management Client > Rules and Events > Webhooks, right-click Webhooks and select Add New…

In Webhook Information:

1. Name field: Enter “IFTTT Gmail”

2. Address field: Set the address to the one from step 11 of the previous section. It should be something similar to: https://maker.ifttt.com/trigger/xprotect_test/json/with/key/lPY4YYsvGSfTSJBM54MrDDSOGWTmk6z9VSD113hxoDY

Click Save in the toolbar to save the new webhook.

In Management Client > Rules and Events > Rules, right-click Rules and select Add Rule… to start the Manage Rule wizard at Step 1: Type of rule.

In Step 1: Type of rule > Name field, enter Send Gmail and add an optional description of the rule in the Description field.

In the Select the rule type you want you create pane, select Perform an action on <event>

In the Edit the rule description pane, click event and in Events > External Events > User-defined Events, select Event High.

Click OK to create the event.

Click Next to go to Step 2: Conditions.

In Step 2: Conditions, apply any conditions relevant to the event you are creating.

Click Next to go to Step 3: Actions.

In Step 3: Actions, scroll down and select Send event info to <Webhook>.

Click address on the Edit the rule description pane

Add the IFTTT Gmail webhook and click OK.

Click Next to go to Step 4: Stop criteria.

In Step 4: Stop criteria, click Finish to create the rule.

Open Management Client > Rules and Events and click User-defined Events.

Select Event High and click Test Event to test the event.

Open the inbox of the Gmail account you specified in the IFTTT web application above to verify you have received the correct email with the event you triggered.

Go to the IFTTT website and log in with your IFTTT credentials.

Go to My Applets - IFTTT

Click the If Maker Event ‘xprotect_test’, then ...Applet

Click Settings

Click Then

Edit the text of the email subject or email body, for example rename the subject to Event High from XProtect

Click Update action and then click Update.

Download and install Node.js from https://nodejs.org.

Create a folder anywhere in your file system and name the folder webhooks.

Open a terminal and navigate to the webhooks folder you just created.

Run npm init and use the default values.

Run npm install express.

Inside the webhooks folder, create a file and name the file index.js.

Open the index.js file in a text editor and paste the sample code below into the index.js file.

const express = require('express');
const crypto = require('crypto');

// change SECRET_TOKEN for your own token
// never hard code the token in the code
// we do it only for demonstration purposes
// instead, store it as an environment variable
const SECRET_TOKEN = "32212c72863c01a931609c5ebfe1abc5";


const isSignatureValid = (body, headerSignature, secretToken) => {
    const digest = crypto.createHmac("sha256", secretToken).update(body).digest();
    const expectedSignature = `sha256=${digest.toString('base64').toString('utf-8')}`;
    if (expectedSignature.length !== headerSignature?.length) return false;
    return crypto.timingSafeEqual(Buffer.from(headerSignature), Buffer.from(expectedSignature));
}


const app = express();
app.use(express.json());
 

app.post('/webhooks', (req, res) => {
    if (!isSignatureValid(
            JSON.stringify(req.body), 
            req.headers['x-hub-signature-256'], 
            SECRET_TOKEN)){
	    console.log('Received event with invalid signature');
        return res.status(403).end();
    }
    console.log('Received event from XProtect through Webhook:');
    console.log(req.body);
    res.send('');
})

app.listen(5000, () => {
  console.log(`Server started...`);
})

In the terminal, run node -p "require('crypto').randomBytes(64).toString('hex');" to generate your own secret token.

Copy the token string and paste it in line 8 of index.js replacing the example token.

Save the index.js file

Use the terminal to run node index.js. The log message Server started should be displayed.

In Management Client > Rules and Events > Webhooks, right-click Webhooks and select Add New…

1. In Webhook Information:

2. Name field: Enter Node integration

3. Token (optional) field: Enter the token string you copied into the index.js file.

4. Address field: Set the address of the receiving server.

   If you created the Node.js server on the same machine as the Event Server, enter http://127.0.0.1:5000/webhooks

   If you created the Node.js server on a server with a public IP address, enter https://<IP>:5000/webhooks where <IP> is the IP address of the server with a public address.

   For Node.js servers on machines without public addresses, see the section below.

   You can use http:// instead of https://, but using http:// through non-secure networks may expose event data in plain text. Using the more secure https:// is strongly recommended.

Click Save in the toolbar to save the new webhook.

In Management Client > Rules and Events > Rules, right-click Rules and select Add Rule… to start the Manage Rule wizard at Step 1: Type of rule.

In Step 1: Type of rule > Name field, enter Send Event High to Node and add an optional description of the rule in the Description field.

In the Select the rule type you want you create pane, select Perform an action on <event>

In the Edit the rule description pane, click event and in Events > External Events > User-defined Events, select Event High.

Click OK to create the event.

Click Next to go to Step 2: Conditions.

In Step 2: Conditions, apply any conditions relevant to the event you are creating.

Click Next to go to Step 3: Actions.

In Step 3: Actions, scroll down and select Send event info to <Webhook>.

Click webhook on the Edit the rule description pane

Add the Node integration webhook and click OK.

Click Next to go to Step 4: Stop criteria.

In Step 4: Stop criteria, click Finish to create the rule.

Open Management Client > Rules and Events and click User-defined Events.

Select Event High and click Test Event to test the event.

Open the console that is running the server. The Received event from XProtect through Webhook log message should be displayed.

https://www.python.org/

Create a folder anywhere in your file system and name the folder webhooks

Open a terminal and navigate to the webhooks folder you just created.

Create a virtual environment inside the folder by using the command python -m venv venv

Activate the virtual environment by using the command \venv\Scripts\activate

Install the Flask server by using the command pip install flask

Inside the webhooks folder, create a file and name the file main.py.

Open the main.py file in a text editor and paste the sample code below into the main.py file.

from flask import Flask, request
import hashlib
import hmac
import base64

# change SECRET_TOKEN for your own token
# never hard code the token in the code
# we do it only for demonstration purposes
# instead, store it as an environment variable
SECRET_TOKEN = bytes("383b9d27c4a892626881d73b0f70c5b62b213ab89d33c8788ac85bd750dbdf59", 'utf-8')


def is_signature_valid(body: bytes, header_signature: str, secret_token: bytes) -> bool:
    digest: bytes = hmac.HMAC(key=secret_token, msg=body, digestmod=hashlib.sha256).digest()
    expected_signature: str = f"sha256={base64.b64encode(digest).decode('utf-8')}"
    return hmac.compare_digest(header_signature, expected_signature)


app = Flask(__name__)


@app.route('/webhooks', methods=['POST'])
def webhooks():
    body = request.data
    header_signature = request.headers.get('X-Hub-Signature-256', '')
    if not is_signature_valid(body, header_signature, SECRET_TOKEN):
        print('Received event with invalid signature')
        return '', 403

    print("Received event from XProtect through Webhook:")
    print(request.json)
    return '', 200


app.run(host='127.0.0.1', port=5000)

In the Python interpreter, run the import secrets; print(secrets.token_hex(32)) command to generate your own secret token string.

Copy and paste the token string in line 10 of the main.py script file, replacing the dummy token string of the sample code.

Save your changes to the main.py script file.

Use the terminal to run the python main.py command. The * Serving Flask app 'main' log message should be displayed.

In Management Client > Rules and Events > Webhooks, right-click Webhooks and select Add New…

1. In Webhook Information:

2. Name field: Enter Python integration

3. Token (optional) field: Enter the token string you copied into the main.py file.

4. Address field: Set the address of the receiving server.

   If you installed Python on the same machine where the Event Server, enter http://127.0.0.1:5000/webhooks

   If you installed Python on a server with a public IP address, enter https://<IP>:5000/webhooks where <IP> is the IP address of the server with a public address.

   For Python installed on machines without public addresses, see the section below.

   You can use http:// instead of https://, but using http:// through non-secure networks may expose event data in plain text. Using the more secure https:// is strongly recommended..

Click Save in the toolbar to save the new webhook.

In Management Client > Rules and Events > Rules, right-click Rules and select Add Rule… to start the Manage Rule wizard at Step 1: Type of rule.

In Step 1: Type of rule > Name field, enter Send Event High to Python and add an optional description of the rule in the Description field.

In the Select the rule type you want you create pane, select Perform an action on <event>

In the Edit the rule description pane, click event and in Events > External Events > User-defined Events, select Event High.

Click OK to create the event.

Click Next to go to Step 2: Conditions.

In Step 2: Conditions, apply any conditions relevant to the event you are creating.

Click Next to go to Step 3: Actions.

In Step 3: Actions, scroll down and select Send event info to <Webhook>.

Click address on the Edit the rule description pane

Add the Python integration webhook and click OK.

Click Next to go to Step 4: Stop criteria.

In Step 4: Stop criteria, click Finish to create the rule.

Open Management Client > Rules and Events and click User-defined Events.

Select Event High and click Test Event to test the event.

Open the console that is running the server. The Received event from XProtect through Webhook log message should be displayed.