> 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/webhook-scopes.md). # Webhook scopes Webhook scopes allow you to define the specific types of events that trigger notifications from claimr to your application. This gives you granular control over the information you receive, ensuring your application only receives relevant updates. ## **Webhook scopes in claimr** **`user_activity`:** This scope covers a wide range of user actions within your claimr campaigns, such as: * **Task Completion:** When a user successfully completes a task within a quest. * **Quest Completion:** When a user completes an entire quest. **`user_reward`:** This scope focuses on events related to users receiving rewards, including: * **Reward Allocation:** When a user receives a reward for completing a task, quest, or other action. **`referral`:** This scope covers events related to user referrals, including: * **Referral Join:** When a new user joins your campaign through a referral link. * **Referral Action:** When a referred user completes an action within your campaign (which may result in bonus points for the referrer). **`user_login`:** This scope focuses on user authentication events: * **Sign-in:** When a user logs in to your campaign using any supported method (e.g., wallet, Twitter, Discord). ## **Choosing the right scope** The appropriate scope for your webhook depends on the specific needs of your application. * If you need to track all user activity within your campaigns, the `user_activity` scope is a good choice. * If you're primarily interested in reward-related events, use the `user_reward` scope. * For referral tracking, choose `referral`. * If you want to monitor user login and logout events, the `user_logi` scope is most suitable. **Example:** The `authentication` scope is particularly useful for integrations with tools like Zapier. By tracking user login events, you can trigger automated workflows in Zapier, such as adding new users to your email list or CRM system. If you have questions about specific webhook scopes or need further clarification, please refer to the claimr [API documentation](/api.md) or contact our support team. --- # 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/webhook-scopes.md?ask=&goal= ``` `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.