Webhooks

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.

Example scenarios

Here are a few scenarios in which you would use webhooks:

• If you want to have an internal points system for your users, webhooks let you add credits to users in your database every time a loyalty action happens.

• If you want to send custom rewards to your users based on the specific loyalty action they take, you can use webhooks to automate this.

Getting started

Step 1: Add a webhook URL to your program

1. Go to the Options step in the Program Editor.

2. In the Set up integrations section, click the Webhooks card. Then enter your webhook endpoint URL.

3. Publish/save your changes.

Tips:

• You can test your webhook URL to see if it is set up properly and/or to see the different types of data from each webhook event. Simply click the Test button right next to the webhook URL input field.

• You can select the specific events to receive within the advanced webhook settings section.

• A total of 5 webhooks can be added per program.

Retry logic

If we are unable to deliver a webhook the first time, LoyaltySurf will attempt to redeliver your webhooks for several days with an exponential back off. After several days of failed attempts we will mark the webhook as undeliverable and it will no longer be retried.

LoyaltySurf uses a queue system with persistent storage, so if our webhook servers ever experience downtime or become unavailable, webhook events will be retried once the servers are restored. You can always check our System Status page for webhook health.

Next steps

View Examples of implementing webhooks, or view what the request payloads for webhook events look like:

• When a participant reaches a reward goal

• When a new participant is added to the program

• When the program ends