Skip to main content
Version: Next

Introduction to Webhooks

Webhooks allow you to receive real-time notifications when specific events occur in the Beedeez platform. Instead of repeatedly polling our API for changes, webhooks push data to your application as events happen, making your integration more efficient and responsive.

What are Webhooks?​

Webhooks are HTTP callbacks that deliver event notifications to your specified endpoint URL. When an event occurs in Beedeez (such as a certificate being completed or expired), we send an HTTP POST request to your configured webhook URL with relevant data about the event.

How Webhooks Work​

  1. Configuration: You configure webhook endpoints in the Beedeez back office by specifying:

    • The URL where you want to receive notifications
    • Which event types you want to subscribe to
    • Authentication method for securing the webhook
    • Custom headers and timeout settings

  2. Event Occurs: When a subscribed event happens in the platform (e.g., a user completes a certificate), Beedeez detects the event.

  3. Notification Sent: Beedeez sends an HTTP POST request to your configured endpoint with a JSON payload containing event details.

  4. Your Response: Your endpoint receives the webhook, processes the data, and returns an HTTP 2xx status code to acknowledge receipt.

  5. Retry Logic: If your endpoint doesn't respond successfully, Beedeez automatically retries the webhook delivery with exponential backoff.

Benefits of Using Webhooks​

  • Real-time Updates: Receive notifications instantly when events occur
  • Reduced API Calls: No need to poll the API repeatedly for changes
  • Efficient Integration: Build event-driven workflows that react to platform changes
  • Scalable: Handle high volumes of events without overwhelming your systems

Use Cases​

Common use cases for webhooks include:

  • Certificate Management: Notify your HR system when employees complete certifications
  • Learning Analytics: Track certificate completions and progress in your data warehouse
  • User Synchronization: Keep user data synchronized between Beedeez and your systems
  • Automated Workflows: Trigger actions in other systems based on learning events
  • Compliance Reporting: Generate reports when certificates expire or need renewal

Getting Started​

To start using webhooks:

  1. Read the Configuration Guide to learn how to set up webhook endpoints
  2. Review the Event Types Reference to see available events
  3. Understand Authentication Options to secure your webhooks
  4. Check Payload Examples to see what data you'll receive

Important Considerations​

  • Endpoint Security: Always use HTTPS endpoints and implement authentication
  • Idempotency: Design your webhook handler to be idempotent (safe to receive the same event multiple times)
  • Response Time: Respond quickly (within 5 seconds) to avoid timeouts
  • Error Handling: Return appropriate HTTP status codes to control retry behavior
  • Testing: Test your webhook endpoint thoroughly before enabling in production

Support​

If you need help with webhooks, please contact our support team.