Lipscore API

https://members.lipscore.com/apidoc/v2/
Admin
Lipscore API provides a RESTful interface for integrating customer ratings, product reviews,...
Tokens:15,521
Snippets:137
Trust Score:8.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Question JSON response example

Source: https://members.lipscore.com/apidoc/v2/schemas/Question

Expected JSON response for a question, showing all schema fields with example values.

```json
{
  "id": 39216,
  "text": "Does it have a wi-fi module?",
  "translated_text": "Czy ma moduł WiFi?",
  "lang": "en",
  "created_at": "2022-12-24T14:50:56.410Z",
  "user": {
    "id": 56634,
    "name": "John Doe",
    "short_name": "John",
    "email": "johndoe@example.com"
  },
  "product": {
    "name": "Lipscore Ultra i9 SmartPhone",
    "gtin": "3234567890126",
    "sku": "Lipscore_4716051",
    "variant_id": "Lipscore_4716051_Black",
    "mpn": "XTR-4590A",
    "internal_id": "4716051"
  },
  "answer": {
    "id": 316,
    "question_id": 39216,
    "text": "Yes, it is",
    "created_at": "2022-09-30T21:23:30Z",
    "updated_at": "2022-09-30T21:23:30Z",
    "member_site": "Demo site"
  }
}
```

--------------------------------

### Answer schema example

Source: https://members.lipscore.com/apidoc/v2/schemas/Answer

Example JSON object for the Answer schema, showing all fields with sample values.

```json
{
  "id": 316,
  "question_id": 39216,
  "text": "Yes, it is",
  "created_at": "2022-09-30T21:23:30Z",
  "updated_at": "2022-09-30T21:23:30Z",
  "member_site": "Demo site"
}
```

--------------------------------

### User schema example

Source: https://members.lipscore.com/apidoc/v2/schemas/User

Example response for the User schema, showing the fields id, name, short_name, and email with sample values.

```json
{
  "id": 56634,
  "name": "John Doe",
  "short_name": "John",
  "email": "johndoe@example.com"
}
```

--------------------------------

### Product JSON Example

Source: https://members.lipscore.com/apidoc/v2/schemas/Product

Example of a Product object in JSON format, showing all fields including nested ai_summary and reviews arrays. Use this as a reference for the expected structure when working with the Lipscore API.

```json
{
  "id": 1807875,
  "internal_id": "4716051",
  "sku": [
    "Lipscore_4716051",
    "Lipscore_4716051_Black"
  ],
  "name": "Lipscore Ultra i9 SmartPhone",
  "brand": "Lipscore",
  "gtin": "3234567890126",
  "mpn": "XTR-4590A",
  "urls": [
    "http://mysite.com/products/lipscore-ultra-i9/6268A",
    "http://mysite.com/products/lipscore-ultra-i9-black/6128B"
  ],
  "votes": 18,
  "rating": "4.4",
  "review_count": 1,
  "internal_ids": [
    "4716051",
    "AB2137X"
  ],
  "ai_summary": {
    "product_id": 123,
    "text": "Customers often mention the stylish look, good leather, and generally high-quality finish...",
    "created_at": "2026-06-30T10:15:00Z",
    "lang": "en",
    "highlights": [
      "Quality fabric",
      "Comfortable fit",
      "Stylish look"
    ],
    "reviews_count": 157
  },
  "reviews": [
    {
      "id": 39216,
      "text": "This product is great! I will be back for more, thank you!",
      "translated_text": "string",
      "created_at": "2022-12-24T14:50:56.410Z",
      "votes_up": 1,
      "votes_down": 0,
      "purchase_date": "2022-11-27T11:14:59.230Z",
      "rating": 5,
      "user": {},
      "images": [
        {}
      ],
      "review_reply": {},
      "internal_order_id": "778203",
      "internal_customer_id": "84021",
      "internal_attr_1": "Attribute 1",
      "internal_attr_2": "Attribute 2",
      "internal_attr_3": "Attribute 3",
      "internal_attr_4": "Attribute 4",
      "internal_attr_5": "Attribute 5",
      "testimonial": true,
      "displayed_name": "John Doe",
      "imported_at": "2019-08-24T14:15:22Z",
      "product": {},
      "attributes": [
        null
      ]
    }
  ],
  "ratings": "string"
}
```

--------------------------------

### AISummary schema example

Source: https://members.lipscore.com/apidoc/v2/schemas/AISummary

Example JSON object for the AISummary schema. Shows all fields with sample values: product_id, text, created_at, lang, highlights, and reviews_count.

```json
{
  "product_id": 123,
  "text": "Customers often mention the stylish look, good leather, and generally high-quality finish...",
  "created_at": "2026-06-30T10:15:00Z",
  "lang": "en",
  "highlights": [
    "Quality fabric",
    "Comfortable fit",
    "Stylish look"
  ],
  "reviews_count": 157
}
```

--------------------------------

### Invitation JSON example

Source: https://members.lipscore.com/apidoc/v2/schemas/Invitation

Example JSON response for an invitation object, including fields such as id, invitation_token, created_at, purchased_at, lang, cancelled, invitation_date, invitation_sent_at, invitation_clicked_at, second_invitation_date, second_invitation_sent_at, second_invitation_clicked_at, invitation_type, landing_url, landing_unreceived_url, internal_order_id, internal_customer_id, internal_attr_1-5, source_id, source_name, parent_source_id, parent_source_name, products, user, first_reminder_sent_at, and second_reminder_sent_at.

```json
{
  "invitation": {
    "id": 1521893,
    "invitation_token": "8475e5d62d5b4a9d72cfbff7a6440ccf820ee17d",
    "created_at": "2022-12-24T14:48:43.932Z",
    "purchased_at": "2022-12-24T14:48:43.874Z",
    "lang": "en",
    "cancelled": false,
    "invitation_date": "2022-12-25T14:48:43.874Z",
    "invitation_sent_at": null,
    "invitation_clicked_at": null,
    "second_invitation_date": null,
    "second_invitation_sent_at": null,
    "second_invitation_clicked_at": null,
    "invitation_type": "product",
    "landing_url": "http://mysite.com/products/lipscore-ultra-i9/6268A?lipscore_token=eyJwdXJjaGFzZSI6eyJyZW1pbmRlcl90b2tlbiI6Ijg0NzVlNWQ2MmQ1YjRhOWQ3MmNmYmZmN2E2NDQwY2NmODIwZWUxN2QiLCJoYXNfZGlzY291bnQiOnRydWUsInByb2R1Y3RzIjpbeyJpZCI6MTgwLCJuYW1lIjoidGVzdHAzIG5hbWUifV0sImFiX3Rlc3QiOm51bGx9LCJzZXR0aW5ncyI6eyJyYXRpbmdfdHlwZSI6IjUtc3RhcnMiLCJyYXRpbmdfc3Rhcl90eXBlIjoidGhpY2siLCJyYXRpbmdfc3Rhcl9jb2xvciI6IiMyYjk5Y2YiLCJyYXRpbmdfd2lkZ2V0X3R5cGUiOiJjb21wYWN0IiwicmF0aW5nX3NtYWxsX3R5cGUiOiIxLXN0YXIiLCJmZWF0dXJlcyI6WyJyYXRpbmdzX3Jldmlld3MiLCJyYXRpbmdzX3Jldmlld3MiLCJyZW1vdmVfYnJhbmRpbmciLCJsb3dfdHJpZ2dlciJdfX0=&lipscore_received=1",
    "landing_unreceived_url": "http://mysite.com/products/lipscore-ultra-i9/6268A?lipscore_token=eyJwdXJjaGFzZSI6eyJyZW1pbmRlcl90b2tlbiI6Ijg0NzVlNWQ2MmQ1YjRhOWQ3MmNmYmZmN2E2NDQwY2NmODIwZWUxN2QiLCJoYXNfZGlzY291bnQiOnRydWUsInByb2R1Y3RzIjpbeyJpZCI6MTgwLCJuYW1lIjoidGVzdHAzIG5hbWUifV0sImFiX3Rlc3QiOm51bGx9LCJzZXR0aW5ncyI6eyJyYXRpbmdfdHlwZSI6IjUtc3RhcnMiLCJyYXRpbmdfc3Rhcl90eXBlIjoidGhpY2siLCJyYXRpbmdfc3Rhcl9jb2xvciI6IiMyYjk5Y2YiLCJyYXRpbmdfd2lkZ2V0X3R5cGUiOiJjb21wYWN0IiwicmF0aW5nX3NtYWxsX3R5cGUiOiIxLXN0YXIiLCJmZWF0dXJlcyI6WyJyYXRpbmdzX3Jldmlld3MiLCJyYXRpbmdzX3Jldmlld3MiLCJyZW1vdmVfYnJhbmRpbmciLCJsb3dfdHJpZ2dlciJdfX0=&lipscore_received=0",
    "internal_order_id": "778203",
    "internal_customer_id": "84021",
    "internal_attr_1": "Attribute 1",
    "internal_attr_2": "Attribute 2",
    "internal_attr_3": "Attribute 3",
    "internal_attr_4": "Attribute 4",
    "internal_attr_5": "Attribute 5",
    "source_id": "storo1",
    "source_name": "Storo Shopping Center",
    "parent_source_id": "south",
    "parent_source_name": "South",
    "products": [
      {
        "landing_star_urls": [],
        "attributes": []
      }
    ],
    "user": {
      "id": 56634,
      "name": "John Doe",
      "short_name": "John",
      "email": "johndoe@example.com"
    },
    "first_reminder_sent_at": "2024-05-24T14:48:43.874Z",
    "second_reminder_sent_at": "2024-06-01T12:40:22.874Z"
  }
}
```

--------------------------------

### ReviewReply JSON Example

Source: https://members.lipscore.com/apidoc/v2/schemas/ReviewReply

Example JSON object representing a ReviewReply with all fields: id, review_id, member_id, text, created_at, and updated_at.

```json
{
  "id": 7832,
  "review_id": 39216,
  "member_id": 6781,
  "text": "Thank you!",
  "created_at": "2022-12-25T07:06:34.362Z",
  "updated_at": "2022-12-26T08:13:55.231Z"
}
```

--------------------------------

### Review JSON Example

Source: https://members.lipscore.com/apidoc/v2/schemas/Review

Example JSON object representing a Lipscore Review. It includes fields such as id, text, translated_text, created_at, votes, purchase_date, rating, user details, images, review_reply, internal identifiers, product information, and attributes. The example shows the structure and sample values for the Review schema.

```json
{
  "id": 39216,
  "text": "This product is great! I will be back for more, thank you!",
  "translated_text": "string",
  "created_at": "2022-12-24T14:50:56.410Z",
  "votes_up": 1,
  "votes_down": 0,
  "purchase_date": "2022-11-27T11:14:59.230Z",
  "rating": 5,
  "user": {
    "id": 56634,
    "name": "John Doe",
    "short_name": "John",
    "email": "johndoe@example.com"
  },
  "images": [
    {
      "id": 134,
      "thumb_url": "https://static-staging.lipscore.com/uploads/000/000/000/thumb_000000000134.jpg",
      "image_url": "https://static-staging.lipscore.com/uploads/000/000/000/000000000134.jpg"
    }
  ],
  "review_reply": {
    "text": "Thank you!",
    "created_at": "2022-12-25T07:06:34.362Z",
    "translated_text": "Gracias!",
    "member_site": "Demo site",
    "lang": "en"
  },
  "internal_order_id": "778203",
  "internal_customer_id": "84021",
  "internal_attr_1": "Attribute 1",
  "internal_attr_2": "Attribute 2",
  "internal_attr_3": "Attribute 3",
  "internal_attr_4": "Attribute 4",
  "internal_attr_5": "Attribute 5",
  "testimonial": true,
  "displayed_name": "John Doe",
  "imported_at": "2019-08-24T14:15:22Z",
  "product": {
    "name": "Lipscore Ultra i9 SmartPhone",
    "gtin": "3234567890126",
    "sku": "Lipscore_4716051",
    "variant_id": "Lipscore_4716051_Black",
    "mpn": "XTR-4590A",
    "internal_id": "4716051"
  },
  "attributes": [
    "string"
  ]
}
```

--------------------------------

### Error schema example

Source: https://members.lipscore.com/apidoc/v2/schemas/Error

Example JSON response body for the Error schema. Contains the required fields 'status' and 'message', both strings.

```json
{
  "status": "string",
  "message": "string"
}
```

--------------------------------

### Rating object example

Source: https://members.lipscore.com/apidoc/v2/schemas/Rating

Complete example of a Rating object as returned by the Lipscore API. Shows all fields including user, product, and internal attributes. Use as a reference for expected response structure.

```json
{
  "id": 33198,
  "created_at": "2022-12-24T14:50:56.410Z",
  "updated_at": "2022-12-24T16:30:01.410Z",
  "status": null,
  "lang": "no",
  "origin": "email",
  "support_case_created_at": null,
  "rating": 5,
  "user": {
    "id": 56634,
    "name": "John Doe",
    "short_name": "John",
    "email": "johndoe@example.com"
  },
  "product": {
    "name": "Lipscore Ultra i9 SmartPhone",
    "gtin": "3234567890126",
    "sku": "Lipscore_4716051",
    "variant_id": "Lipscore_4716051_Black",
    "mpn": "XTR-4590A",
    "internal_id": "4716051"
  },
  "internal_order_id": "778203",
  "internal_customer_id": "84021",
  "internal_attr_1": "Attribute 1",
  "internal_attr_2": "Attribute 2",
  "internal_attr_3": "Attribute 3",
  "internal_attr_4": "Attribute 4",
  "internal_attr_5": "Attribute 5"
}
```

--------------------------------

### Hook Object Example

Source: https://members.lipscore.com/apidoc/v2/schemas/Hook

Example of a Hook object as returned by the Lipscore API. It includes the Hook ID, the event type, and the target URL that will receive event data.

```json
{
  "id": 1,
  "event": "rating_created",
  "target_url": "http://mysite.com/hooks/78"
}
```

--------------------------------

### GET /products/{id}

Source: https://members.lipscore.com/apidoc/v2

Retrieves a product by its ID. This endpoint is part of the Lipscore API V2 and requires authentication.

```APIDOC
## [GET] /products/{id}

### Description
Retrieves a product by its ID. This endpoint is part of the Lipscore API V2 and requires authentication.

### Method
GET

### Endpoint
/products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The product identifier.

#### Query Parameters
- **api_key** (string) - Required - Your API key.

### Request Example
```
curl --header "X-Authorization: YourSecretAPIKey" https://api.lipscore.com/products/1?api_key=YourAPIKey
```

### Response
#### Success Response (200)
- **product** (object) - The product details.

#### Response Example
```json
{
  "id": "1",
  "name": "Example Product"
}
```

```

--------------------------------

### ProductMinimal JSON Example

Source: https://members.lipscore.com/apidoc/v2/schemas/ProductMinimal

A complete JSON object representing a product with all fields: name, gtin, sku, variant_id, mpn, and internal_id. Use this as a template for creating or validating product data in the Lipscore API.

```json
{
  "name": "Lipscore Ultra i9 SmartPhone",
  "gtin": "3234567890126",
  "sku": "Lipscore_4716051",
  "variant_id": "Lipscore_4716051_Black",
  "mpn": "XTR-4590A",
  "internal_id": "4716051"
}
```

--------------------------------

### Authenticate with api_key and X-Authorization header

Source: https://members.lipscore.com/apidoc/v2

Authenticate API requests by sending the API key in the api_key parameter and the Secret API key in the X-Authorization header. Use HTTPS for all requests and keep the Secret API key private.

```bash
curl --header "X-Authorization: YourSecretAPIKey" https://api.lipscore.com/products/1?api_key=YourAPIKey
```

--------------------------------

### POST question_created

Source: https://members.lipscore.com/apidoc/v2/webhooks/question_created/post

This webhook is triggered when a new question is created in Lipscore. It sends a POST request to your registered endpoint with the question data.

```APIDOC
## POST question_created

### Description
This webhook is triggered when a new question is created in Lipscore. It sends a POST request to your registered endpoint with the question data.

### Method
POST

### Endpoint
question_created

### Parameters
#### Request Body
- **id** (integer) - Required - Question ID. Example: 39216
- **text** (string) - Required - Question text. Example: Does it have a wi-fi module?
- **created_at** (string<date-time>) - Required - Date of the question creation. Example: 2022-12-24T14:50:56.410Z
- **status** (string) - Required - Status of the question. Available: new, deleted, answered, support. Example: new
- **published** (boolean) - Required - Whether this question was published or not. Example: true
- **lang** (string) - Required - Language code. Example: en
- **member_site_id** (integer) - Required - Lipscore member site ID (ID of an account). Example: 1317
- **event** (string) - Required - The event type that triggered this webhook. Example: question_created
- **event_type** (string) - Required - The type of object that was created. Example: question
- **answer** (object) - Optional - Answer object.
  - **id** (integer) - Example: 316
  - **question_id** (integer) - Example: 39216
  - **text** (string) - Example: Yes, it is
  - **created_at** (string<date-time>) - Example: 2022-09-30T21:23:30Z
  - **updated_at** (string<date-time>) - Example: 2022-09-30T21:23:30Z
  - **member_site** (string) - Example: Demo site
- **user** (object) - Required - User information.
  - **id** (integer) - User ID. Example: 56634
  - **name** (string) - User name. Example: John Doe
  - **email** (string) - User email address. Example: johndoe@example.com
- **product** (object) - Required - Product information.
  - **sku** (array[string]) - Product SKU(s). Example: ["Lipscore_4716051","Lipscore_4716051_Black"]
  - **brand** (string) - Product brand. Example: Lipscore
  - **id** (string) - Product ID. Example: 1807875
  - **internal_id** (string) - Internal product ID. Example: 4716051
  - **name** (string) - Product name. Example: Lipscore Ultra i9 SmartPhone
  - **gtin** (string) - Global Trade Item Number. Example: 3234567890126
  - **mpn** (string) - Manufacturer part number. Example: XTR-4590A
  - **category** (string) - Product category. Example: smartphones
  - **url** (string) - Product URL. Example: http://mysite.com/products/lipscore-ultra-i9/6268A
  - **currency** (string) - Product currency. Example: EUR
- **origin** (object) - Optional - Origin information.
  - **member_site_name** (string or null) - Member site name if syndication is enabled. Example: Demo site

### Request Example
{
  "id": 39216,
  "text": "Does it have a wi-fi module?",
  "created_at": "2022-12-24T14:50:56.410Z",
  "status": "new",
  "published": true,
  "lang": "en",
  "member_site_id": 1317,
  "event": "question_created",
  "event_type": "question",
  "answer": {
    "id": 316,
    "question_id": 39216,
    "text": "Yes, it is",
    "created_at": "2022-09-30T21:23:30Z",
    "updated_at": "2022-09-30T21:23:30Z",
    "member_site": "Demo site"
  },
  "user": {
    "id": 56634,
    "name": "John Doe",
    "email": "johndoe@example.com"
  },
  "product": {
    "sku": ["Lipscore_4716051","Lipscore_4716051_Black"],
    "brand": "Lipscore",
    "id": "1807875",
    "internal_id": "4716051",
    "name": "Lipscore Ultra i9 SmartPhone",
    "gtin": "3234567890126",
    "mpn": "XTR-4590A",
    "category": "smartphones",
    "url": "http://mysite.com/products/lipscore-ultra-i9/6268A",
    "currency": "EUR"
  },
  "origin": {
    "member_site_name": "Demo site"
  }
}

### Response
#### Success Response (200)
Webhook received successfully

#### Response Example
(No response body provided)

#### Error Response (410)
(No description provided)
```

--------------------------------

### Review Schema

Source: https://members.lipscore.com/apidoc/v2/schemas/Review

The Review object represents a product review. It contains review content, rating, user details, images, reply, and product information.

```APIDOC
## Review Schema

### Description
The Review object represents a product review. It contains review content, rating, user details, images, reply, and product information.

### Fields
- **id** (integer) - Lipscore review ID. Example: 39216
- **text** (string) - Review text content. Example: "This product is great! I will be back for more, thank you!"
- **translated_text** (string or null) - Translated review text.
- **created_at** (string<date-time>) - When the review was created. Example: 2022-12-24T14:50:56.410Z
- **votes_up** (integer) - Number of up votes for the review. Example: 1
- **votes_down** (integer) - Number of down votes for the review. Example: 0
- **purchase_date** (string<date-time>) - When the product was purchased. Example: 2022-11-27T11:14:59.230Z
- **rating** (integer or null) - Rating given in the review (1-5). Example: 5
- **user** (object) - User who wrote the review.
  - **id** (integer) - User ID. Example: 56634
  - **name** (string) - User full name. Example: "John Doe"
  - **short_name** (string) - User short name. Example: "John"
  - **email** (string<email>) - User email address. Example: "johndoe@example.com"
- **images** (array[object]) - Images attached to the review.
  - **id** (integer) - Image ID. Example: 134
  - **thumb_url** (string<uri>) - URL to image thumbnail. Example: "https://static-staging.lipscore.com/uploads/000/000/000/thumb_000000000134.jpg"
  - **image_url** (string<uri>) - URL to full size image. Example: "https://static-staging.lipscore.com/uploads/000/000/000/000000000134.jpg"
- **review_reply** (object or null) - Reply to the review.
  - **text** (string) - Reply text content. Example: "Thank you!"
  - **created_at** (string<date-time>) - When the reply was created. Example: 2022-12-25T07:06:34.362Z
  - **translated_text** (string or null) - Translated reply text. Example: "Gracias!"
- **member_site** (string) - Name of the member site. Example: "Demo site"
- **lang** (string) - Language code. Example: "en"
- **internal_order_id** (string or null) - Internal order ID from merchant system. Example: "778203"
- **internal_customer_id** (string or null) - Internal customer ID from merchant system. Example: "84021"
- **internal_attr_1** (string or null) - Custom attribute 1. Example: "Attribute 1"
- **internal_attr_2** (string or null) - Custom attribute 2. Example: "Attribute 2"
- **internal_attr_3** (string or null) - Custom attribute 3. Example: "Attribute 3"
- **internal_attr_4** (string or null) - Custom attribute 4. Example: "Attribute 4"
- **internal_attr_5** (string or null) - Custom attribute 5. Example: "Attribute 5"
- **testimonial** (boolean) - Whether this is a testimonial. Example: true
- **displayed_name** (string or null) - Display name for the reviewer. Example: "John Doe"
- **imported_at** (string<date-time> or null) - When the review was imported.
- **product** (object) - Product this review is for.
  - **name** (string) - Product name. Example: "Lipscore Ultra i9 SmartPhone"
  - **gtin** (string or null) - Global Trade Item Number. Example: "3234567890126"
  - **sku** (string) - Product SKU. Example: "Lipscore_4716051"
  - **variant_id** (string or null) - Product variant ID. Example: "Lipscore_4716051_Black"
  - **mpn** (string) - Manufacturer Part Number. Example: "XTR-4590A"
  - **internal_id** (string) - Internal product ID. Example: "4716051"
- **attributes** (array[string]) - Product attributes.

### Example
```json
{
  "id": 39216,
  "text": "This product is great! I will be back for more, thank you!",
  "translated_text": "string",
  "created_at": "2022-12-24T14:50:56.410Z",
  "votes_up": 1,
  "votes_down": 0,
  "purchase_date": "2022-11-27T11:14:59.230Z",
  "rating": 5,
  "user": {
    "id": 56634,
    "name": "John Doe",
    "short_name": "John",
    "email": "johndoe@example.com"
  },
  "images": [
    {
      "id": 134,
      "thumb_url": "https://static-staging.lipscore.com/uploads/000/000/000/thumb_000000000134.jpg",
      "image_url": "https://static-staging.lipscore.com/uploads/000/000/000/000000000134.jpg"
    }
  ],
  "review_reply": {
    "text": "Thank you!",
    "created_at": "2022-12-25T07:06:34.362Z",
    "translated_text": "Gracias!",
    "member_site": "Demo site",
    "lang": "en"
  },
  "internal_order_id": "778203",
  "internal_customer_id": "84021",
  "internal_attr_1": "Attribute 1",
  "internal_attr_2": "Attribute 2",
  "internal_attr_3": "Attribute 3",
  "internal_attr_4": "Attribute 4",
  "internal_attr_5": "Attribute 5",
  "testimonial": true,
  "displayed_name": "John Doe",
  "imported_at": "2019-08-24T14:15:22Z",
  "product": {
    "name": "Lipscore Ultra i9 SmartPhone",
    "gtin": "3234567890126",
    "sku": "Lipscore_4716051",
    "variant_id": "Lipscore_4716051_Black",
    "mpn": "XTR-4590A",
    "internal_id": "4716051"
  },
  "attributes": [
    "string"
  ]
}
```
```

--------------------------------

### POST review_created

Source: https://members.lipscore.com/apidoc/v2/webhooks/review_created/post

This webhook is triggered when a new review is created in Lipscore. It sends a POST request to your registered endpoint with the review data.

```APIDOC
## POST review_created

### Description
This webhook is triggered when a new review is created in Lipscore. It sends a POST request to your registered endpoint with the review data.

### Method
POST

### Endpoint
review_created

### Parameters
#### Request Body
- **event** (string) - Required - The event type that triggered this webhook. Example: `review_created`
- **event_type** (string) - Required - The type of object that was created. Example: `reviews`
- **lang** (string) - Required - Language code. Example: `en`
- **status** (string) - Required - Status of the review. Example: `new`
- **review_reply** (object) - Optional - Reply information.
  - **text** (string) - Optional - Reply text. Example: `Thank you!`
  - **created_at** (string<date-time>) - Optional - When the reply was created. Example: `2022-12-25T07:06:34.362Z`
- **testimonial** (boolean) - Required - Whether this is a testimonial. Example: `true`
- **text** (string) - Required - Review text content. Example: `This product is great! I will be back for more, thank you!`
- **created_at** (string<date-time>) - Required - When the review was created. Example: `2022-12-24T14:50:56.410Z`
- **updated_at** (string<date-time>) - Required - When the review was last updated. Example: `2022-12-24T16:30:01.410Z`
- **images** (array[object]) - Optional - Images attached to the review.
  - **id** (integer) - Optional - Image ID. Example: `134`
  - **thumb_url** (string) - Optional - Thumbnail image URL. Example: `https://static-staging.lipscore.com/uploads/000/000/000/thumb_000000000134.jpg`
  - **image_url** (string) - Optional - Full image URL. Example: `https://static-staging.lipscore.com/uploads/000/000/000/000000000134.jpg`
  - **flag** (string) - Optional - Flag for the review (e.g., media content). Example: `media_content`
- **displayed_name** (string or null) - Required - Display name for the reviewer. Example: `John Doe`
- **member_site_id** (integer) - Required - Lipscore member site ID (ID of an account). Example: `1317`
- **purchase_date** (string<date-time>) - Required - When the product was purchased. Example: `2022-11-27T11:14:59.230Z`
- **votes_down** (integer) - Required - Number of down votes for the review. Example: `0`
- **votes_up** (integer) - Required - Number of up votes for the review. Example: `1`
- **id** (integer) - Required - Review ID. Example: `39216`
- **product** (object) - Required - Product information.
  - **sku** (array[string]) - Optional - Product SKU(s). Example: `["Lipscore_4716051","Lipscore_4716051_Black"]`
  - **brand** (string) - Optional - Product brand. Example: `Lipscore`
  - **id** (string) - Optional - Product ID. Example: `1807875`
  - **internal_id** (string) - Optional - Internal product ID. Example: `4716051`
  - **name** (string) - Optional - Product name. Example: `Lipscore Ultra i9 SmartPhone`
  - **gtin** (string) - Optional - Global Trade Item Number. Example: `3234567890126`
  - **mpn** (string) - Optional - Manufacturer part number. Example: `XTR-4590A`
  - **category** (string) - Optional - Product category. Example: `smartphones`
  - **url** (string) - Optional - Product URL. Example: `http://mysite.com/products/lipscore-ultra-i9/6268A`
  - **currency** (string) - Optional - Product currency. Example: `EUR`
- **user** (object) - Required - User information.
  - **id** (integer) - Optional - User ID. Example: `56634`
  - **name** (string) - Optional - User name. Example: `John Doe`
  - **email** (string) - Optional - User email address. Example: `johndoe@example.com`
  - **internal_customer_id** (string) - Optional - Internal customer ID. Example: `84021`
- **rating** (object or null) - Optional - Associated rating.
  - **event** (string) - Optional - The event type that triggered this webhook. Example: `rating_created`
  - **event_type** (string) - Optional - The type of object that was created. Example: `rating`
  - **lang** (string) - Optional - Language code. Example: `en`
  - **member_site_id** (integer) - Optional - Lipscore member site ID (ID of an account). Example: `1317`
  - **rating** (integer) - Optional - Rating value (1-5). Example: `5`
  - **created_at** (string<date-time>) - Optional - When the rating was created. Example: `2022-09-29T09:25:14.558Z`
  - **updated_at** (string<date-time>) - Optional - When the rating was last updated. Example: `2022-09-29T09:25:14.558Z`
  - **id** (integer) - Optional - Rating ID. Example: `1528`
- **invitation** (object) - Optional - Purchase/invitation details.
  - **source_id** (string) - Optional - Example: `storo1`
  - **source_name** (string) - Optional - Example: `Storo Shopping Center`
  - **parent_source_id** (string) - Optional - Example: `south`
  - **parent_source_name** (string) - Optional - Example: `South`

### Request Example
```json
{
  "event": "review_created",
  "event_type": "reviews",
  "lang": "en",
  "status": "new",
  "review_reply": {
    "text": "Thank you!",
    "created_at": "2022-12-25T07:06:34.362Z"
  },
  "testimonial": true,
  "text": "This product is great! I will be back for more, thank you!",
  "created_at": "2022-12-24T14:50:56.410Z",
  "updated_at": "2022-12-24T16:30:01.410Z",
  "images": [
    {
      "id": 134,
      "thumb_url": "https://static-staging.lipscore.com/uploads/000/000/000/thumb_000000000134.jpg",
      "image_url": "https://static-staging.lipscore.com/uploads/000/000/000/000000000134.jpg",
      "flag": "media_content"
    }
  ],
  "displayed_name": "John Doe",
  "member_site_id": 1317,
  "purchase_date": "2022-11-27T11:14:59.230Z",
  "votes_down": 0,
  "votes_up": 1,
  "id": 39216,
  "product": {
    "sku": ["Lipscore_4716051", "Lipscore_4716051_Black"],
    "brand": "Lipscore",
    "id": "1807875",
    "internal_id": "4716051",
    "name": "Lipscore Ultra i9 SmartPhone",
    "gtin": "3234567890126",
    "mpn": "XTR-4590A",
    "category": "smartphones",
    "url": "http://mysite.com/products/lipscore-ultra-i9/6268A",
    "currency": "EUR"
  },
  "user": {
    "id": 56634,
    "name": "John Doe",
    "email": "johndoe@example.com",
    "internal_customer_id": "84021"
  },
  "rating": {
    "event": "rating_created",
    "event_type": "rating",
    "lang": "en",
    "member_site_id": 1317,
    "rating": 5,
    "created_at": "2022-09-29T09:25:14.558Z",
    "updated_at": "2022-09-29T09:25:14.558Z",
    "id": 1528
  },
  "invitation": {
    "source_id": "storo1",
    "source_name": "Storo Shopping Center",
    "parent_source_id": "south",
    "parent_source_name": "South"
  }
}
```

### Response
#### Success Response (200)
Webhook received successfully

#### Response Example
```json
{}
```

#### Error Response (410)
Gone - The webhook endpoint is no longer available.

```
Tokens:
Raw