Creating Webhooks

Overview

Webhooks in Caf Connect allow you to receive real-time notifications when specific events occur in your account. You can create and configure webhooks through the Trust portal.

Accessing webhook management

  1. Log in to the Trust portal:

    • Navigate to the Trust portal and authenticate with your credentials.

  2. Navigate to API Configurations:

    • From the dashboard, locate the navigation menu.

    • Click on Settings (gear icon) in the menu.

    • Select API Configurations from the menu.

API Configurations

  1. Access Webhooks Section:

    • On the API configurations page, click on the Webhooks tab.

    • This page displays all your existing webhooks with their status, payload URLs, and available actions.

Webhooks List

Creating a new webhook

To create a new webhook, follow these steps:

  1. Start Webhook Creation:

    • Click the "+ New webhook" button in the page header.

  2. Configure Webhook Settings:

    • A New webhook modal will appear where you can configure your webhook settings.

New Webhook Modal

Basic configuration

Payload URL: Enter the URL where Caf should send webhook events. This must be a valid HTTPS endpoint that can receive POST requests.

Secret: Provide a secret key that will be used to generate the webhook signature. This allows you to verify that requests are genuinely from Caf.

Authentication configuration

Choose the authentication method for your webhook endpoint:

None

No authentication will be used when sending webhook requests.

Basic authentication

Basic Auth Configuration

Provide username and password credentials that will be included in webhook requests using HTTP Basic Authentication.

API key authentication

API Key Configuration

Configure API key authentication by specifying:

  • Header: The header name (e.g., X-API-Key)

  • Value: The API key value

Event selection

Choose which events should trigger your webhook:

Send me everything

This option will send all available events to your webhook endpoint.

Let me select individual events

Event Selection

When you select this option, you can choose specific events from the available list. The interface will display all currently supported events, including Communication Events, Transaction Events, and Authentication Events.

The events shown in the interface are for illustrative purposes only. The actual events list may differ, as new events can be added or existing events can be modified over time. Always refer to the current interface for the most up-to-date list of available events.

For detailed information about each event type, their structure, and payload examples, refer to the Events documentation.

Activation

Check the "Active" checkbox to enable the webhook immediately after creation. You can always enable or disable webhooks later from the management interface.

Completing webhook creation

After configuring all settings:

  1. Review your webhook configuration

  2. Click "Create webhook" to finalize the setup

  3. Your new webhook will appear in the webhooks list and start receiving events based on your configuration

Next steps

After creating your webhook:

Last updated