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

# Webhooks

## **Understanding webhooks and endpoints**

Webhooks are a powerful tool for staying informed about real-time events happening within your claimr campaigns. They provide an efficient way to receive instant updates, allowing your application to react dynamically to user actions and provide a more personalized experience.

#### **What is a webhook?**

A webhook is an automated message that claimr sends to your application whenever a specific event occurs in your campaigns. Instead of your application constantly checking for new information (a process called "polling"), claimr proactively notifies you when something important happens, such as a user completing a task or claiming a reward.

Webhooks in claimr have an organization-wide scope. This means that any user activity within your entire organization, across all associated campaigns, will trigger a notification to your registered endpoint.

#### **What is an endpoint?**

To receive these webhook messages, you need to set up a dedicated URL on your server, called an endpoint. This endpoint acts as the receiving address where claimr can deliver these real-time updates. It's important to ensure that your endpoint is properly configured to receive and process incoming data.

#### **Why use webhooks?**

Webhooks offer several advantages over traditional polling methods:

* **Real-time updates:** Get instant notifications about important events, enabling your application to react quickly and provide timely feedback to users.
* **Efficient data handling:** Receive only the data you need, when you need it, reducing unnecessary data transfer and processing.
* **Reduced polling:** Eliminate the need for your application to continuously check for updates, saving resources and improving performance.

To dive deeper into specific aspects of webhooks in ⚡️claimr, check out our detailed articles.

<table data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Set up webhooks</strong></td><td><a href="/files/UcGDlHkamqGcqQdJeXsL">/files/UcGDlHkamqGcqQdJeXsL</a></td><td><a href="/pages/u3FxTuzdogPMxTuy8ec3">/pages/u3FxTuzdogPMxTuy8ec3</a></td></tr><tr><td align="center"><strong>Webhook scopes</strong></td><td><a href="/files/AjE7ug7jCw0WFqluYbN5">/files/AjE7ug7jCw0WFqluYbN5</a></td><td><a href="/pages/7gWEm5emnOxrTVq5WrDH">/pages/7gWEm5emnOxrTVq5WrDH</a></td></tr></tbody></table>


---

# 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.claimr.io/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.
