What is a webhook

A Webhook is a push-based mechanism for real-time data delivery. When events occur in SCALAR, instead of you having to request the data, SCALAR automatically sends the data to a URL you specify (your webhook endpoint). This ensures your application always has the most current information with the least possible delay.

Webhooks are a powerful way for web applications to communicate with each other in real time. A webhook is an HTTP based callback function that provides push notifications, allows lightweight and event-driven communication between two APIs. It is an event notification sent to a URL of your choice. The users can configure webhooks to trigger events on one site and invoke behavior on another. For example, a webhook can notify a project management tool when a new issue is created in a bug tracking system. The webhooks are useful for integrating with third-party services and other external API that support them.

Key Features:

  • Real-time Push Delivery: Events are sent to your endpoint immediately as they occur, eliminating polling delays.
  • Batch Processing: Events are grouped into batches before delivery, optimizing network efficiency and reducing API calls.
  • Automatic Retries: Failed deliveries are automatically retried with exponential backoff to ensure reliability.
  • Secure Delivery: HMAC signatures verify that webhook payloads come from SCALAR, ensuring data integrity and security.
  • Flexible Configuration: Customize headers, batch sizes, and linger times to fit your application's needs.
  • Custom Headers Support: Add up to 5 custom headers to webhook requests for integration with your internal systems.
  • Webhook Testing: Validate your webhook configuration before full activation with test payload delivery.
  • Overflow Protection: Automatically buffer data during high-volume periods to prevent event loss.