SCAUT Webhooks Documentation

Introduction

Webhooks in SCAUT provide a reliable mechanism for external systems to receive notifications about key events in real-time. Instead of polling the API, your system automatically receives relevant updates as soon as an event occurs. You define which events are important and specify where notifications should be sent.

This approach ensures efficient integration, minimizes delays, and accelerates data processing while maintaining security and reliability.

General Principle of Operation

1. Connection Setup: You provide SCAUT with a valid endpoint for receiving notifications and define the events you want to track.
2. Event Occurrence: When a specified event occurs, SCAUT initiates the process of sending a notification.
3. Notification Transmission: SCAUT automatically sends a structured HTTP POST request to the designated endpoint.
4. Handling the Notification: Your system processes the received notification and performs the necessary actions (e.g., updating a status, triggering an internal workflow, etc.).

Event Triggers

Webhooks in SCAUT can be triggered by various system events. While the full list of supported events is available upon request, some common categories include:

• Process Status Updates – Notifications when a process reaches a new stage.
• Order Status Changes – Events related to order creation, processing, and completion.
• System Notifications – Alerts for specific system-related updates.

Key Setup Considerations

• Event Selection: Determine which SCAUT events are relevant to your integration.
• Specifying the Notification Endpoint: Provide a secure, publicly accessible endpoint (HTTPS required) where notifications will be delivered.
• Data Format Agreement: Work with the SCAUT team to define the preferred format for receiving notifications, ensuring proper data handling on your end.
• Response Handling: Your endpoint should return an HTTP 2xx status code to acknowledge receipt of webhook notifications.

Security Considerations

SCAUT ensures that webhook transmissions are secure and protected against unauthorized access:

• HTTPS Required: Only HTTPS endpoints are supported to ensure encrypted data transmission.
• Authentication Mechanisms: Webhook requests include security measures to verify authenticity.
• Minimal Data Exposure: Webhook payloads contain only the necessary information and exclude sensitive details.
• Rate Limiting: Webhook requests are subject to rate limiting to prevent misuse.

Error Handling and Reliability

• Delivery Retries: If the receiving endpoint is temporarily unavailable, SCAUT retries delivery using an exponential backoff strategy.
• Timeout Handling: Your system should process webhook requests efficiently and respond within a reasonable time to avoid dropped notifications.
• Logging and Monitoring: It is recommended to log webhook interactions for debugging and tracking purposes.

If an error occurs, the webhook system may provide a retry attempt or log the failure for review.

Implementation Steps

1. Request Webhook Integration: Contact the SCAUT team to enable webhook functionality for your account.
2. Define Event Subscriptions: Specify which events you want to receive notifications for.
3. Provide a Secure Endpoint: Ensure that your system has a publicly accessible, HTTPS-enabled endpoint for receiving webhook notifications.
4. Implement Webhook Handling: Develop a listener that can:
   1. Receive HTTP POST requests.
   2. Validate and parse incoming webhook payloads.
   3. Process data as per business logic.
5. Testing and Validation: Work with the SCAUT team to verify webhook delivery and proper handling in your system.

How to Subscribe to Webhooks

Registration Process

1. Submit a Webhook Request
   1. Contact SCAUT support to enable webhook functionality.
   2. Provide a valid HTTPS endpoint.
   3. Select the event types you want to track.
2. Endpoint Verification
   1. SCAUT may validate your endpoint before activating webhook delivery.
   2. Additional security validation may be required.
3. Managing Webhooks
   1. Review and update subscribed events as needed.
   2. Request test events for validation purposes.

Final Considerations

• Webhooks provide real-time updates and enhance automation.
• Secure implementation practices are required to maintain data integrity.
• The SCAUT team is available for support and setup assistance.

For further details or technical support, contact the SCAUT team.