Webhooks

Fera allows developers to integration into any custom systems using webhooks.

Webhook Integration Setup

To add custom webhooks navigate to Integrations section and connect the Webhooks integrations by clicking on the "Connect" button found here:

Webhook integration

Afterwards you'll be asked for the webhook URL you want to use. You should enter them in here.

Webhook settings screen

A good way to test the webhooks is to sign up for a pipedream.com or requestbin.com account. These services give you a temporary URL you can use for testing.

After you save your webhook URLs Fera will automatically test the connections by performing a POST request with an empty body.

Available Webhook Events

There are 4 events that you can configure your webhooks for:

  1. New Submission - This gets triggered whenever a review, photo or video is submitted together.

  2. New Review - This gets triggered whenever a new review is submitted.

  3. New Photo - This gets triggered whenever a new photo is submitted (for each new photo).

  4. New Video - This gets triggered whenever a new video is submitted (for each new video).

Testing a Content Submission

To test a content submission you'll want to navigate to a product page on your site that is using Fera and add ?fera=showContentSubmit to the URL.

This will bring up the content submission UI for you to test submitting a review, photo and/or a video.

Securing the Webhook

Your webhook is hit with a secret_key param that represents your store's secret key. Your store's secret key can be found in your store setting section in the main tab.

Make sure the secret_key param matches the one from your account before doing anything in your webhook response.

By validating that the correct secret key you know that the request was sent by Fera and not someone else.

Webhook Post Data

The webhook event will post data related to the event that you're reacting to:

Content Submission
Customer Review
Customer Photo
Customer Video
Content Submission

See Content Submission model data schema.

Customer Review

See Customer Review model data schema.

Customer Photo

See Customer Photo model data schema.

Customer Video

See Customer Video model data schema.