> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/connect/webhook/creating-webhooks.md).

# Creating Webhooks

## Overview

Webhooks in 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](/files/0Eyy0GpEkmiSk7AwVVFK)

3. **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](/files/xuzX4EZwbZ8FtZ1GnfPa)

## 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](/files/QeDtdkdwRxZzQZWQSS50)

### Basic configuration

**Payload URL**: Enter the URL where Certta 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 Certta.

### 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](/files/695phE1w9PYMUQAWlVgu)

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

#### API key authentication

![API Key Configuration](/files/HovOLGpkeXivviosb37V)

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](/files/yWY7xNjTYViQL1uu166e)

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.

{% hint style="warning" %}
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.
{% endhint %}

For detailed information about each event type, their structure, and payload examples, refer to the [Events documentation](/caf-api/connect/webhook/events.md).

### 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:

* [Learn about webhook events](/caf-api/connect/webhook/events.md) to understand the data you'll receive
* [Implement signature verification](/caf-api/connect/webhook/signature.md) to ensure webhook authenticity
* [Follow best practices](/caf-api/connect/webhook/best-practices.md) for reliable webhook handling


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.caf.io/caf-api/connect/webhook/creating-webhooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.