What are the best practices for an optimal integration?

Processing reviews with webhooks

1. From your account dashboard, go to API settings and add your backend IP address to the table of IP whitelisting.
2. Add your HTTP webhook endpoint.
3. Make sure to enable all events. Set “Payload” option to Only changes. Keep frequency set to Right away.
4. The first call is very unlikely to include reviews. In the event it does, which can happen when the subscription has been set to idle for some time, make sure to insert them in your DB.

5. Make sure to set autoRenew to true. This will help you save ~⅓ of the cost of the future cycles.
6. When requesting reviews from a page for the first time, make sure to include your page’s internalId. This will help identify the page when receiving calls from our servers.
7. Security:
   1. Configure your webhook to only accept calls from our backend server IP address 18.220.82.182
   2. Check for your API token in the header X-Zembra-Token and confirm the user agent is Zembra-Agent
8. When your endpoint receives a POST request from us, you will find:
   1. The internalId along with details about the description can be found under field subscription.
   2. The updated details about the target.
   3. Under updates field you will find 5 array fields: newReviews, editedReviews, newReplies, deletedReviews, restoredReviews.
   4. editedReviews and newReplies may and may not include reviews seen also under newReviews.
   5. Rely on the review id, reply id, author id, etc to take adequate CRUD actions.

Other recommendations

• Use the API sandbox when building the integration
• We offer SDKs for 12 programming languages
• Test your webhook from your account
• Stay consistent with your slugs. Preferably use the version returned by the API.

Recommended webhook configuration

Backend-to-Backend Communication