# LoyaltySurf Docs

## LoyaltySurf Docs

- [Welcome](https://docs.loyaltysurf.io/master.md)
- [Tutorials](https://docs.loyaltysurf.io/tutorials.md): Tutorials for common types of loyalty and reward programs
- [REST API](https://docs.loyaltysurf.io/developer-tools/rest-api.md): Use the REST API to add new participants, trigger loyalty actions, get program data, and get participant data from a secure environment.
- [Tutorials](https://docs.loyaltysurf.io/developer-tools/rest-api/tutorials.md): How to implement the LoyaltySurf REST API in common use-case scenarios.
- [Objects](https://docs.loyaltysurf.io/developer-tools/rest-api/api-objects.md)
- [API Reference](https://docs.loyaltysurf.io/developer-tools/rest-api/api-reference.md): This reference documents the LoyaltySurf REST API, including all available public methods and examples of each.
- [API Guidelines](https://docs.loyaltysurf.io/developer-tools/rest-api/api-guidelines.md): Follow these standard guidelines when interacting with LoyaltySurf APIs.
- [API Response Codes](https://docs.loyaltysurf.io/developer-tools/rest-api/api-response-codes.md): Refer to the below response code glossary to help you troubleshoot any errors.
- [Webhooks](https://docs.loyaltysurf.io/developer-tools/webhooks.md): Webhooks send data to your server when important events occur in your LoyaltySurf program. This lets you automatically fulfill any custom reward or update users in your database.
- [Securing Your Webhooks (optional)](https://docs.loyaltysurf.io/developer-tools/webhooks/securing-your-webhooks.md): This is an optional step. For security purposes, you can add a webhook secret to limit requests sent to your webhook endpoint to those only coming from LoyaltySurf.
- [Examples](https://docs.loyaltysurf.io/developer-tools/webhooks/examples.md): How to implement Webhooks for your LoyaltySurf program.
- [Events Reference](https://docs.loyaltysurf.io/developer-tools/webhooks/events-reference.md): Below are sample request payloads you will receive based on the webhook event types you have selected for your program.
- [Metadata](https://docs.loyaltysurf.io/developer-tools/metadata.md): Use metadata to save any custom data to Participants and Rewards to make your advocate program even more dynamic.
- [Chargebee](https://docs.loyaltysurf.io/integrations/chargebee.md): Automatically apply Chargebee coupons, credits, or trial extensions as rewards.
- [HubSpot](https://docs.loyaltysurf.io/integrations/hubspot.md): Trigger loyalty actions on HubSpot deal stage changes.
- [PayPal](https://docs.loyaltysurf.io/integrations/paypal.md): Automatically send one-time PayPal payouts as rewards.
- [Recurly](https://docs.loyaltysurf.io/integrations/recurly.md): Automatically apply Recurly coupons, credits, or trial extensions as rewards.
- [Slack](https://docs.loyaltysurf.io/integrations/slack.md): Get notified in Slack when events happen in your LoyaltySurf campaign.
- [Stripe](https://docs.loyaltysurf.io/integrations/stripe.md): Automatically apply Stripe coupons, credits, or trial extensions as rewards.
- [Tango Card](https://docs.loyaltysurf.io/integrations/tango-card.md): Automatically fulfill gift card rewards where winners can pick from top retailers (e.g, Amazon, Starbucks) and/or donate to non-profits.
- [XTRM](https://docs.loyaltysurf.io/integrations/tango-card-1.md): Automatically fulfill cash, prepaid cards, and gift card rewards to winners.
- [Zapier](https://docs.loyaltysurf.io/integrations/zapier.md): Zapier is a code-free tool that lets you connect to 5,000+ apps to automate rewards or sync data.
- [Tutorials](https://docs.loyaltysurf.io/integrations/zapier/tutorials.md): We'll walk you through creating Zapier Zaps.
- [Troubleshooting](https://docs.loyaltysurf.io/integrations/zapier/troubleshooting.md): If you are experiencing issues with your Zapier setup, you can use Zapier's Task History feature to help.


---

# 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, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.loyaltysurf.io/master.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.
