The Custom Feed API lets you filter employee recognition feeds by metadata, add labels for recipients, and customize recognition displays. It’s often used with ScreenCloud but can be set up independently. For ScreenCloud integration, see this article.
For clients setting up the Custom Feed API directly, here’s a step-by-step guide to help you configure it.
- Access API Settings
- Configure the Filter Field (In-Platform)
- Select Metadata Labels (Optional)
- Enable Error Notifications
- Configure the API (Metadata Filter)
- Test and Troubleshoot
- Helpful Resources
Access API Settings
To get started with the Custom Feed API, log in to your Awardco Admin Portal and access the necessary configuration settings.
- Log in to your Awardco account.
- Select the “Admin” button at the bottom of the left navigation menu.
- Select “Platform” then “Integrations” then “API Settings” from the left navigation menu.
- Click on the “API Configuration” tab.
This will open the page where you can configure both the in-platform settings and the API configuration necessary for your Custom Feed.
Configure the Filter Field (In-Platform)
The Filter Field allows you to control how recognitions are filtered based on metadata fields, such as location, department, or any other category relevant to your organization. This filter ensures that only the recognitions that match certain criteria are displayed. To configure the filter field:
- Choose a metadata field that will act as the filter. For example, if your company has multiple office locations, you could use the Location metadata field.
- Click “Save Changes”.
Example:
For a company with offices in different cities, selecting Location as the filter allows you to display recognitions based on specific locations, like "London" or "New York."
Note: The Filter Field specifies the metadata field (e.g., "Location"), and you will later define the values to filter by in the API itself.
Select Metadata Labels (Optional)
You can enhance the recognition feed by displaying additional metadata, such as Department or Job Title for each employee receiving recognition. To configure metadata labels:
- Under Sublabel 1 and Sublabel 2, select the metadata fields you want to display. Common examples include Department and Job Title.
- For example, selecting Department and Job Title might display details like "Sales" and "Account Executive."
This step is optional, but it can provide additional context for your recognition feed.
Enable Error Notifications
To ensure your setup runs smoothly, we recommend enabling Error Emails. This feature will notify you if there are any issues with the Custom Feed, such as invalid configurations or missing metadata.
- Find the Send Error Emails option in the settings.
- Enable this feature to receive error notifications.
You can temporarily disable error emails if you're aware of known issues that are being addressed.
Configure the API (Metadata Filter)
Once the in-platform settings are configured, you will need to define the specific values for filtering using the metadataFilter request parameter in API calls.
- The in-platform Metadata Filter setting determines which field is used for filtering (e.g., Location).
- The API parameter metadataFilter specifies which value in that field should be used as the filtering criteria (e.g., only show recognitions where "Location" = "Las Vegas" on this screen).
To configure the API:
- In the API setup, use the metadataFilter request parameter to specify values for filtering.
- Ensure that the value matches the metadata values stored in your user data.
Example API call:
https://api.awardco.com/api/feed?metadataFilter=Location:London
This ensures that only recognitions tagged with the London location metadata are displayed. If any metadata fields are modified or removed, you must update the filter configuration accordingly.
Test and Troubleshoot
Once you’ve completed the setup, it’s important to test the feed to ensure everything is displaying correctly.
- Verify that the filter is properly applied and that the right recognitions are shown based on your configured settings.
- If you encounter any issues, check your Error Email notifications for more details.
Helpful Resources
To assist with the setup and provide more detailed guidance, here are some helpful resources:
- API Documentation: Complete guide on using the Custom Feed API, with parameters and examples.
- Awardco API Resources: API docs and support.
If you have any questions, please contact Awardco Admin Support.