Update your system as items change via HTTP

Orca Scan uses webhooks to let your application know when an event happens, such as adding a new item or updating a quantity. We'll HTTP POST a JSON object to your URL with the data that changed and who changed it.

For example, let's assume a user scanned a VIN number and added Vehicle Information to a sheet named Vehicle Checks. We'd HTTP POST the following:

{ "___orca_action": "add", "___orca_sheet_name": "Vehicle Checks", "___orca_user_email": "hidden@requires.https", "___orca_row_id": "5cf5c1efc66a9681047a0f3d", "VIN": "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", }

Fields prefixed with ___orca_ are system fields, they're designed to contain enough information for your system to make sense of the event.

Key Type Description
___orca_action string The type of action that was performed. Values include add, update, delete and test
___orca_sheet_name string Name of the sheet
___orca_user_email string The registered email address of the user who preformed the action - requires a HTTPS connection
___orca_row_id string Unique row ID

Fields without the ___orca_ prefix contain the actual data entered from the device.

1. Create a new sheet

Create a new Orca Scan cloud sheet

Start by creating a sheet named Vehicle Checks using the Vehicle Information template.

2. Edit Sheet Integrations

Opening the sheet integration menu

Once created, open the Integration Settings by clicking the sheet menu on the newly created tab.

3. Add your WebHook URL

Sheet lookup URL input

Now enter the URL you would like to receive the event notifications. You can create a temporary test URL by visiting webhook.site

Security

You can provide a secret that will be sent to your server as a HTTP header with every request, allowing you to determine if the incoming request is from Orca Scan.

4. Test your WebHook URL

Sheet lookup test result

Test your WebHook URL by clicking the Test button. This will send an HTTP POST to your server with a JSON object containing test data matching the structure of your sheet.

5. Save the changes

Finally, save your changes and you're done.

WebHook questions?

We're happy to help you troubleshoot any issues, chat with us live or drop us an email.