> For the complete documentation index, see [llms.txt](https://guide.plumber.gov.sg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.plumber.gov.sg/user-guides/start-the-workflow/webhook.md).

# Webhook

## What is a webhook?

A webhook allows two applications to communicate with each other in real time. When a specific event occurs—such as an external app calling a Plumber webhook URL when new data is available—the source application automatically sends a notification to the destination application. This ensures information stays up to date without requiring manual checks or updates.

{% hint style="warning" %}
Limited support will be provided for webhooks, as they are intended for advanced users.
{% endhint %}

## Catch raw webhook

You can test the webhook by sending a GET, POST, PUT, or PATCH request to the URL provided.

<figure><img src="/files/FfKliUQBYBnztRfcFnUK" alt=""><figcaption></figcaption></figure>

## Check step

**Check step** will return the data that was sent to the webhook.

## Support policy

Please note that our team may not be able to respond to queries about this feature, as it is not currently a priority. While the feature remains available for use, users should consult their technical teams or the documentation for implementation support. We are focusing our efforts on other strategic priorities and core system functionality. If you find any information missing from this document, we will be happy to update it to better serve your needs.


---

# 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://guide.plumber.gov.sg/user-guides/start-the-workflow/webhook.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.