Send rewards automatically with a reward connection

Audience: Marketers, admins, and the developer who owns your reward endpoint

A reward connection is a URL on your side (your own server, or a tool such as a gift card platform) where HighAdvocacy sends a reward the moment it is issued. Your endpoint then adds the credits, sends the gift card, or starts the order.

You only need a connection for rewards that send automatically. Rewards set to Manual by team don’t need one.

One connection can serve many rewards, so when the URL changes you update it in one place.

Before you start

• A URL that is reachable from the public internet and starts with https://.
• Any login header your server needs, for example an API key.
• Optional: your workspace signing secret from Settings → Security, so your server can check each request came from HighAdvocacy. See Delivery payload reference.

Add a reward connection

1. Open Rewards in the sidebar, then the Delivery tab.
2. Click Add connection (or Add reward connection if you already have one).
3. Under Connection, enter a Connection name your team will recognize, and the Connection URL. Click the icon beside the name to pick an icon and color.
4. Under Custom headers, add any login header your server needs. Click Add another for more rows.
5. Click Test connection. We send a test to the URL and show the result.
6. Click Create connection.

You can also add a connection while creating a reward: under Delivery, choose Reward connection, then + Create new reward connection. See Reward catalog.

Test results

Use the connection on a reward

Open a reward in the Catalog tab. Under Delivery, choose Reward connection, pick your connection from Choose a reward connection, and save. Every reward that uses the connection now sends through it.

The Delivery tab

Each row shows:

• Reward connection: the name.
• Sends to: the host of the URL, or URL not set.
• Status: Active or Needs attention.
• Used by: how many rewards use it, or Not used.
• Delivered: how many rewards it has delivered.

Filter by Status, or click Search.

Click a connection to open it. Edit its details and click Save connection. The panel on the right shows:

• Health: Last delivery (Delivered, Failed, or Not tested), Last tested, and Updated.
• Used by: the rewards that send through this connection.

When a connection needs attention

If a send through the connection fails, its status changes to Needs attention and its page shows The last reward didn’t send:

Rewards on this connection won’t send until you fix it. Check the URL and login headers. Then select Test connection.

To fix it:

1. Open the failed reward in Activity and read the error under its status. It tells you what went wrong, for example that your server refused the request or didn’t answer in time.
2. Open the connection from the Delivery tab and correct the Connection URL or Custom headers.
3. Click Test connection, then Save connection.
4. Back in Activity, click Retry on the failed reward, or Retry all failed.

Common errors and fixes:

Related

• Reward catalog
• Reward activity
• Delivery payload reference
• Security settings