Admin Guide
- Introduction
- Basic
- User Name and Password
- API Key and secret
- Business Unit ID
- Other
- Data Management
- Schedulers and Retrieve All Reviews button
- Webhooks
- Advanced
- Licence
Introduction
Under the Sugar Administration page there is a section called Provident ® TrustPilot Add-On Configuration which brings user to TrustPilot settings.
Basic
Basic settings need to be populated from your Trustpilot Business account.
User Name and Password
User Name and Password are Trustpilot user credentials. Existing user can be used or new one added.
API Key and secret
Api Key and API secret need to be setup in Integrations → Developers → APIs.
Here new application should to be added (note that domains are not mandatory)
Once application is created Api key and secret can be copied from it.
Business Unit ID
Business unit id can be retrieved by using following url:
https://api.trustpilot.com/v1/business-units/find?apikey={API_KEY}&name={BUSSINESS_NAME}
i.e.
https://api.trustpilot.com/v1/business-units/find?apikey=bTCkA3bHBBsHc7TG5gpTRPpUNVtt2n1a&name=www.mybusiness.com
Using url in browser will return answer like this where highlighted id is business unit id:
Other
Reply To - default should be existing user email, it can be the same as login user email
From Name - should be “No Reply” if default no reply email address is set, if reply email is set then name should be changed properly
From Email Address: default is noreply.invitations@trustpilotmail.com that prevents replies
Language - is template language, default is en_US
Data Management
Provides settings for data manipulation and button to retrieve all data from Trustpilot.
Schedulers and Retrieve All Reviews button
- Days to check information request:
- Specify number of days to check information requests
- There is a scheduler that checks all Trustpilot Review records that have status Requested Information and tries to see if reviewer provided information
i.e if this setting is set to 90 it will check only records created in last 90 days
Days to check invitations:
- Specify number of days to check invitations
- There is a scheduler that checks all Trustpilot Review records that have status Sent and tries to see if review was created
i.e if this setting is set to 90 it will check only records created in last 90 days
Days to retrieve TP reviews:
- Specify number of days to update reviews
- There is a scheduler that pulls all reviews from Trustpilot created in previous N days. This number specified how many days should be used
- i.e if this setting is set to 180 it will check only Trustpilot reviews created in last 180 days
- NOTES
- This scheduler is used to get organic reviews too
- This value can be set to 0 to get all reviews from Trustpilot
- This value is used with button Retrieve All Reviews
Recommended value is 7, to update only records created in last 7 days especially if Webhooks are used.
Reference module
- if module is specified it will use it to try automatically relate review from Trustpilot to SugarCRM record
- i.e. if your Reference id in Trustpilot is equal to Order id, setting Reference module to Orders and reference field to id will connect them and automatically relate to order in system, if order exists
- Reference Field
- field from module that should be check to relate records
- Retrieve All Reviews
- button used to retrieve all records from Trustpilot created in previous N days, specified by field Days to retrieve TP reviews
Webhooks
Webhooks can be specified in Trustpilot to send data to SugarCRM once user created/edited/deleted review. Settings are provided in admin panel:
- Webhook username
- username to be used in webhook
it’s recommended to set this value to prevent invalid values coming to system
Webhook password
- password to be used in webhook
it’s recommended to set this value to prevent invalid values coming to system
Webhook review created link
info about link that should be put in Trustpilot settings for created reviews
Webhook review updated link
info about link that should be put in Trustpilot settings for updated reviews
Webhook review deleted link
- info of about that should be put in Trustpilot settings for deleted reviews
In Trustpilot this settings are under Integrations → Developers → Webhooks
Select Add new subscription under Service reviews
Url for subscription should be entered, i.e.
https://username:password@company.sugarcloud.com/index.php?entryPoint=PrTrustPilotReviewCreated
Where username and password are values specified in Trustpilot settings in SugarCRM.
Advanced
Advanced settings contain advanced connection details and shouldn’t be changed if there are no issues.
If there are issues Log Level can be changed from debug to fatal. Then all plugin errors will be logged to SugarCRM log.
Licence
At Licence tab Admin should enter licence key for the extension.