orca-webhook-node

Example of how to build an Orca Scan WebHook endpoint and Orca Scan WebHook In using NodeJS and express framework.

Install

First ensure you have Node.js installed:

# should return 11 or higher
node -v

Then execute the following:

# download this example code
git clone https://github.com/orca-scan/orca-webhook-node.git

# go into the new directory
cd orca-webhook-node

# install dependencies
npm install

Run

# start the project
npm start

Your WebHook receiver will now be running on port 3000.

You can emulate an Orca Scan WebHook using cURL by running the following:

curl --location --request POST 'http://127.0.0.1:3000/orca-webhook-out' \
--header 'Content-Type: application/json' \
--data-raw '{
    "___orca_action": "add",
    "___orca_sheet_name": "Vehicle Checks",
    "___orca_user_email": "[email protected]",
    "___orca_row_id": "5cf5c1efc66a9681047a0f3d",
    "Barcode": "4S3BMHB68B3286050",
    "Make": "SUBARU",
    "Model": "Legacy",
    "Model Year": "2011",
    "Vehicle Type": "PASSENGER CAR",
    "Plant City": "Lafayette",
    "Trim": "Premium",
    "Location": "52.2034823, 0.1235817",
    "Notes": "Needs new tires"
}'

Important things to note

1. Only Orca Scan system fields start with ___
2. Properties in the JSON payload are an exact match to the field names in your sheet (case and space)
3. WebHooks are never retried, regardless of the HTTP response

How this example works

This example uses the express framework:

const express = require('express');

const app = express();
// Parse JSON bodies for this app.
app.use(express.json());

app.post('/orca-webhook-out', function(request, response){
    data = request.body;

    // debug purpose: show in console raw data received
    console.log("Request received: \n"+JSON.stringify(data, null, 2));

    // get the name of the action that triggered this request (add, update, delete, test)
    const action = data.___orca_action

    // get the name of the sheet this action impacts
    const sheetName = data.___orca_sheet_name

    // get the email of the user who preformed the action (empty if not HTTPS)
    const userEmail = data.___orca_user_email

    // NOTE:
    // orca system fields start with ___
    // you can access the value of each field using the field name (data.Name, data.Barcode, data.Location)
    switch (action) {
        case "add":
            // TODO: do something when a row has been added
            break;
        case "update":
            // TODO: do something when a row has been updated
            break;
        case "delete":
            // TODO: do something when a row has been deleted
            break;
        case "test":
            // TODO: do something when the user in the web app hits the test button
            break;
      }

    response.sendStatus(200);
});

app.listen(3000, () => console.log('Example app is listening on port 3000.'));

WebHook In

Orca Scan WebHook In

app.get('/trigger-webhook-in', async function(request, response){
    // The following example adds a new row to a sheet, setting the value of Barcode, Name, Quantity and Description
    const json = JSON.stringify(
        { 
            "___orca_action": "add",
            "Barcode": "0123456789",
            "Name": "New 1",
            "Quantity": 12,
            "Description": "Add new row example"
        }
    );
    // TODO: change url to https://api.orcascan.com/sheets/{id}
    const res = await axios.post("https://httpbin.org/post", json, {
    headers: {
        // Overwrite Axios's automatically set Content-Type
        'Content-Type': 'application/json'
    }
    });
    console.log(res.statusText);
    response.sendStatus(200);
});

Use http://127.0.0.1:3000/trigger-webhook-in to trigget the in webhook and send the request.

Test server locally against Orca Cloud

To expose the server securely from localhost and test it easily against the real Orca Cloud environment you can use Secure Tunnels. Take a look at Ngrok or Cloudflare.

ngrok http 3000

Troubleshooting

If you run into any issues not listed here, please open a ticket.

Examples in other langauges

• orca-webhook-dotnet
• orca-webhook-python
• orca-webhook-go
• orca-webhook-java
• orca-webhook-php
• orca-webhook-node

History

For change-log, check releases.

License

© Orca Scan, the Barcode Scanner app for iOS and Android.