# How to Create Webhooks

## Overview

This guide walks through creating a webhook in the Designer to send real-time event notifications to an external system. For an overview of how webhooks work, see [Webhooks](/designer/webhooks/webhooks.md).

***

## Prerequisites

Before creating a webhook:

* Have the target endpoint URL ready (the URL that will receive the webhook payload)
* Confirm the endpoint is accessible and returns a 2xx response for POST requests
* Optionally, have a shared secret ready for signature verification

***

## Steps to Create a Webhook

1. In the Designer, navigate to **Webhooks**.
2. Click **+ Add Webhook**.
3. Enter a **Name** for the webhook (used for identification in the Admin Portal).
4. Enter the **Endpoint URL** – the HTTP/HTTPS URL that will receive payloads.
5. Select the **Events** that trigger this webhook. Common events include:
   * Patient created / updated
   * Assessment completed
   * CDT record created / updated
   * Program enrollment changed
   * Encounter created / completed
6. Optionally enter a **Secret** for payload signature verification.
7. Select the **Environment(s)** this webhook applies to.
8. Save the webhook.

***

## Activating the Webhook

After publishing the Designer change:

1. Go to **Admin Portal → Integrations → Webhooks**.
2. Find the webhook in the list.
3. Click the three dots and select **Activate**.

The webhook will now send payloads when the configured events occur.

***

## Testing

Send a test event to verify your endpoint receives the payload correctly. Review the webhook payload structure and ensure your system can parse the JSON.

***

## Publishing

Create a draft in the Designer and publish. Then activate in the Admin Portal.


---

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

```
GET https://docs.welkinhealth.com/designer/webhooks/how-to-create-webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.