Webhook scopes

Explanation of the different webhook scopes and the events they cover.

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 or contact our support team.