End-to-End Workflow

1. Setup Integrator Access

• Create or manage your integrator in SCALAR Web portal
• Ensure integrator has necessary module-level permissions for the event types you want to receive

2. Create Webhook Subscription

• Navigate to Datahub Subscriptions configuration
• Select subscription method: "Webhook"
• Provide your webhook endpoint URL (must be HTTPS)
• Generated webhook secret for HMAC signature validation
• Select event groups and specific events to subscribe to
• Configure batch settings (batch size, maximum waiting time)
• Optionally add custom headers and enable overflow protection

3. Test Your Webhook

• Use the webhook test feature to send sample events to your endpoint
• Verify your endpoint responds with a 200 status code
• Check that your application processes the test payload correctly

4. Receive Event Data

• SCALAR sends event batches to your webhook endpoint
• Your endpoint processes and acknowledges each batch
• SCALAR retries failed deliveries automatically

5. Monitor and Maintain

• Track webhook delivery status and metrics
• Check Webhook developer metrics for integration insights
• Notifications (Push, Email) for any kind of configurations impact on the subscriptions
• Update custom headers or batch settings as needed