Overview
This article provides guidance on how to create a custom integration for reward fulfillment when using a vendor not officially supported by Influitive. It details the process of enabling 'Reward Metadata', choosing between webhook and API endpoint triggers, and the necessary steps for processing and closing the integration loop. The article emphasizes that while Influitive offers support for technical issues with their webhooks or API, they do not assist in creating the integration itself.
Information
If you currently use a Rewards Fulfillment vendor who Influitive does not maintain an official integration with at this time, it may be possible to create a custom integration using webhooks and/or API. We currently offer official integrations for the following vendors:
Note : Influitive will offer support if there are any technical difficulties with our webhooks or API but will not help create the integration. If you would like to purchase a service for Influitive to potentially build the integration for you, raise this with your CSM and it can be scoped out.
This article will outline the theory of how such a custom integration can be built.
Step 1 - Enable 'Reward Metadata'
Contact support@influitive.com and ask to enable 'Reward Metadata' for your AdvocateHub.
This will allow you to add extra data to your rewards which you can see in the below image. This data will be contained in the payload of the webhook or API call you may make to trigger the integration which we will talk about in the next step.
Step 2 - Triggering
You have two options here:
1 - Trigger using a webhook such as the Reward Redemption Requested webhook
2 - Trigger using our GET Reward Redemptions API Endpoint
The benefit of using option 1 is that it is real-time. The instant the Advocate requests the reward the webhook is triggered. Whereas, with option 2, you will need to poll the endpoint at a time interval of your choosing to return outstanding rewards that need to be fulfilled.
Check out these article for more on our Webhooks and API:
Formatting Influitive Webhooks
Step 3 - Processing
If you decided to go with the webhook option, you will need to use a system like Zapier to catch this webhook which can re-format the data and create an API call which will be sent out to your reward vendor to create the order in their system.
Note : You will need to consult with your reward vendor for details on their API
Similarly, if you with the API option, the data returned will likely need to be formatted in order to create an order in the vendor's system.
Step 4 - Closing The Loop
Regardless of what route you went to build the integration, it is important to close the loop. A reward 'ID' will be sent in the webhook/API payloads. This ID can then be used in an API call to Fulfill or Refuse a reward and you can also include a message here confirming the reward has been fulfilled or perhaps if the reward requested is out of stock or cannot be fulfilled for another reason you can use this message to convey that to the Advocate.
The endpoint details can be found here - https://influitive.readme.io/reference#approvereject-reward
Note: You will need to consult with your reward vendor for details on their system and how they could potentially get this information back to Influitive from a trigger in their system
FAQ
Can Influitive assist in creating a custom integration with my reward vendor?
Influitive will provide technical support for issues with their webhooks or API but does not assist in creating the integration. However, you can discuss the possibility of purchasing a service for Influitive to build the integration with your Customer Success Manager.
What are the primary options for triggering a reward fulfillment process in Influitive?
The primary options are using a webhook for real-time triggering or triggering the process using the GET Reward Redemptions API Endpoint, which requires polling at intervals to identify rewards for fulfillment.
What is the purpose of enabling 'Reward Metadata' in Influitive?
Enabling 'Reward Metadata' allows you to append additional data to your rewards, which becomes part of the payload in webhooks or API calls used to facilitate the custom integration with your reward vendor.
How do I close the integration loop after processing the reward fulfillment?
Closing the integration loop requires using a unique reward 'ID' transmitted via webhook or API payloads to make an API call to either fulfill or refuse a reward, and to communicate the completion status or any issues to the Advocate.
Is it necessary to consult with my reward vendor when setting up a custom integration?
Yes, it is crucial to consult with your reward vendor to understand their system's capabilities for sending confirmation back to Influitive, which is triggered by their internal processes.
Priyanka Bhotika
Comments