How do I set up automated Custom Awards in Nectar?
You can set up a Custom Award to be automatically sent when something important happens outside of Nectar — like closing a deal, resolving a ticket, or completing a milestone. This helps keep recognition timely and consistent across your team's workflow.
Note: This feature is typically set up by a technical team member, such as a developer or IT admin. Once it's configured, everything runs in the background.
Step 1: Enable automation for a Custom Award
In Nectar, go to:
Workspace Settings > Awards > Custom Awards > Create New Award (or edit an existing one).Scroll to the Automation section at the bottom.
Toggle Enable Award Automation to On.
Click Save.
This allows the award to be triggered automatically via API.
Step 2: Share award details with your developer or IT team
To trigger the award via API, your developer will need:
The Award ID (UUID)
A valid API key for your organization
The recipient’s email address
(Optional) A custom message and point value
How to find the Award UUID
Your developer can retrieve the Award UUID by making the following API request:
Endpoint:
GET https://api.nectar.com/v1/custom-awards
Headers:
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
This will return a list of your custom awards. You may need to paginate through results to find the correct UUID.
See the full API reference: GET /v1/custom-awards
Step 3: Trigger the award via API
Once automation is enabled, your developer can send the award using this API request:
Endpoint:
POST https://api.nectarhr.com/v1/custom-awards/send
Headers:
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
Body:
{
"awardUuid": "YOUR_AWARD_UUID",
"recipientEmails": ["[email protected]"],
"message": "Your custom message here",
"points": 100
}
See the full API reference: POST /v1/custom-awards/send
Important notes:
If the points or message fields are left blank in the custom award, they must be included in the API request.
If values are provided in the request, they will override the defaults in the custom award.
Ensure the award is active and automation is enabled, or the API request will not trigger a recognition.
There's no budget enforcement for automated awards yet — use them thoughtfully.
You can turn automation on or off at any time by editing the custom award.