Webhooks

Webhooks are HTTP callbacks that allow Caf to send real-time notifications to your application when specific events occur. This asynchronous communication method ensures your system stays updated without the need for polling our APIs.

Topics

• Creating Webhooks

• Managing Webhooks

• Events

• Request

• Signature

Overview

Webhooks provide a mechanism for Caf to notify your systems when events happen, rather than requiring your application to poll for changes. When an event occurs, Caf sends an HTTP POST request to the configured endpoint URL with information about the event.

Getting started

To start using webhooks with Caf Connect:

1. Set up your webhook endpoint - Create an HTTPS endpoint that can receive POST requests

2. Create and configure your webhook - Use the Trust portal to set up your webhook with the appropriate events and authentication

3. Implement signature verification - Verify webhook authenticity using the provided signatures

4. Handle webhook events - Process the CloudEvents-formatted payloads in your application

The webhook management interface allows you to:

• Create new webhooks with custom event filtering

• Configure authentication methods (None, Basic Auth, or API Key)

• Enable/disable webhooks as needed

• View webhook status and manage existing configurations

Security

All webhook requests are signed using a signature in the headers, allowing you to verify that the request originated from Caf. See Signature for details on how to verify webhook authenticity.