post https://developers.yotpo.com/v2//webhooks?access_token=
Create a webhook and parameters for a specific URL. Events can be review_createand review_updated. Scroll down to view the object structure for each event.
Please note:
You can only create one of each type of webhook.
Webhook Object Structure
Once you've successfully created a webhook, objects are returned according to the event_name created. Webhook events could be review_create and/or review_updated and are structured as shown in the examples below:
{
"event": "review_create",
"data": {
"id": "219",
"source_app_key": "",
"title": "Review Title",
"content": "Review Content",
"user_id": "209",
"score": "5",
"deleted": "false",
"app_key": "StmYvzud6bHLtosn5k5DoGoA7M0kghzjMdH25DST",
"created_at": "2018-02-20 14:12:13 UTC",
"updated_at": "2018-02-20 14:12:13 UTC",
"new": "true",
"user_type": "verifiedBuyer",
"order": {
"id": 523556,
"external_id": "sdfs12vzud6bDoGoA7M0kghzjMdH2weR",
} ,
"customer_email": "plusUser@gmail.com",
"verified_buyer": "true",
"archived": "false",
"shop_owner": "false",
"twitter_pushed": "0",
"facebook_pushed": "0",
"review_source_type_id": "1",
"votes_up": "0",
"votes_down": "0",
"review_type_id": "1",
"source_review_id": "",
"sentiment": ""
}
}
{
"event": "review_updated",
"data": {
"id": "219",
"source_app_key": "",
"title": "Review Title",
"content": "Review Content",
"user_id": "209",
"score": "5",
"deleted": "false",
"app_key": "StmYvzud6bHLtosn5k5DoGoA7M0kghzjMdH25DST",
"created_at": "2018-02-20 14:12:13 UTC",
"updated_at": "2018-02-20 14:12:13 UTC",
"new": "true",
"user_type": "verifiedBuyer",
"verified_buyer": "true",
"order": {
"id": "5456",
"external_id": "sdfs12vzud6bDoGoA7M0kghzjMdH2weR",
},
"customer_email": "plusUser@gmail.com",
"archived": "false",
"shop_owner": "false",
"twitter_pushed": "0",
"facebook_pushed": "0",
"review_source_type_id": "1",
"votes_up": "0",
"votes_down": "0",
"review_type_id": "1",
"source_review_id": "",
"sentiment": ""
}
}
Responses