Integrating your system with our API/Webhook can optimize your workflow by automatically notifying your designated endpoint of new inspections. Follow these steps to seamlessly configure and test the webhook/API integration:
Configuration Steps:
Navigate to the 'Company Settings' > 'Settings' tab
Scroll Down to 'Integrations' > API > Click to Setup > 'Webhook'
Enter Webhook URL: In the provided field, enter the URL where you want the webhook notifications to be sent. This is a mandatory step and ensures that your system receives the necessary data.
You can add some additional random strings on the WebHook URL to enhance security:
Header Name and Value Name
JSON Payload: Enable this option if you prefer to receive data in JSON format for enhanced compatibility.
Save WebHook
Please Note: When Json Payload is turned off, the webhook will fall back to HTTP POST request with parameters
Testing the Integration
Once you've configured the webhook, it's essential to test its functionality to ensure seamless communication between systems.
Simulate Inspection Trigger: Instead of manually initiating inspections for testing purposes, rely on the webhook to simulate the arrival of new inspections. This saves time and effort during the debugging phase. To do this simply:
Navigate back to the 'WebHook'
Click on the 'Test WebHook' button
Make and API Request: Once the nominated endpoint receives the webhook, please make a request to our API using the corresponding Inspection ID to retrieve detailed information.