product-review-request.created

Sent when a Flow's Product review request action sends to a webhook, with the order, its products and the links to the review form.

Flow onlyOnly a Flow sends this event. A destination cannot subscribe to it.

View as Markdown

Use it to send review requests through your own email or SMS tool instead of Cevoid's.

When it fires

Each time a Flow's Product review request action runs with a webhook as its delivery target.
data.review_link opens the review form for the whole order. Each item in data.products has its own review_link, and rating_links from 1 to 5: the same link with its rating parameter set to that number.
full_url is the link to send. query_string and search_params hold its query, for building the link into your own template.

Receive it

In a Flow on Order fulfilled or Order delivered, add the Product review request action, set Delivery target to Webhook and choose your destination. See Send from a Flow.

Payload

Example payload

{
  "created_at": "2026-11-02T09:30:00.000Z",
  "data": {
    "order": {
      "buyer": {
        "email": "buyer@example.com",
        "external_customer_id": "customer_123",
        "profile_id": "prf_sarah"
      },
      "cancelled": false,
      "created_at": "2026-07-24T09:00:01.000Z",
      "currency": "USD",
      "financial_status": "PAID",
      "fulfillment_status": "PENDING",
      "id": "ord_abc123",
      "ingestion_mode": "live",
      "lines": [
        {
          "discount": 0,
          "external_line_id": "line_1",
          "fulfillment_status": "PENDING",
          "product_id": "product_123",
          "quantity": 1,
          "refund": 0,
          "returned_units": 0,
          "sku": "TSHIRT-BLACK-M",
          "unit_price": 50,
          "variant_id": "variant_456"
        }
      ],
      "market_id": "mar_us",
      "money": {
        "discount": 5,
        "refunded": 0,
        "shipping": 5,
        "sub_total": 50,
        "tax": 5,
        "total": 55
      },
      "order_number": "#1001",
      "paid_at": "2026-07-24T09:00:01.000Z",
      "placed_at": "2026-07-24T09:00:00.000Z",
      "source": {
        "connection_id": "erp-production",
        "external_order_id": "order_123",
        "type": "PUBLIC_API"
      },
      "updated_at": "2026-07-24T09:00:01.000Z"
    },
    "products": [
      {
        "product": {
          "id": "prd_abc123",
          "variant_id": "var_abc123"
        },
        "rating_links": {
          "1": {
            "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=1",
            "query_string": "?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=1",
            "search_params": {
              "cevoid.auth": "example-signed-token",
              "cevoid.product": "var_abc123",
              "cevoid.widget": "reviews.product-review",
              "rating": "1"
            }
          },
          "2": {
            "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=2",
            "query_string": "?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=2",
            "search_params": {
              "cevoid.auth": "example-signed-token",
              "cevoid.product": "var_abc123",
              "cevoid.widget": "reviews.product-review",
              "rating": "2"
            }
          },
          "3": {
            "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=3",
            "query_string": "?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=3",
            "search_params": {
              "cevoid.auth": "example-signed-token",
              "cevoid.product": "var_abc123",
              "cevoid.widget": "reviews.product-review",
              "rating": "3"
            }
          },
          "4": {
            "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=4",
            "query_string": "?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=4",
            "search_params": {
              "cevoid.auth": "example-signed-token",
              "cevoid.product": "var_abc123",
              "cevoid.widget": "reviews.product-review",
              "rating": "4"
            }
          },
          "5": {
            "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=5",
            "query_string": "?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123&rating=5",
            "search_params": {
              "cevoid.auth": "example-signed-token",
              "cevoid.product": "var_abc123",
              "cevoid.widget": "reviews.product-review",
              "rating": "5"
            }
          }
        },
        "review_link": {
          "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123",
          "query_string": "?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token&cevoid.product=var_abc123",
          "search_params": {
            "cevoid.auth": "example-signed-token",
            "cevoid.product": "var_abc123",
            "cevoid.widget": "reviews.product-review"
          }
        }
      }
    ],
    "profile": {
      "avatar_url": "https://cdn.cevoid.com/avatars/prf_sarah/profile.jpg",
      "bio": "Lifestyle creator and photography enthusiast",
      "birthday": "1992-04-18",
      "country": "US",
      "created_at": "2026-01-15T09:30:00.000Z",
      "email": "sarah.johnson@example.com",
      "external_id": "customer_7391056823401",
      "first_name": "Sarah",
      "id": "prf_sarah",
      "language": "en",
      "last_name": "Johnson",
      "location": "San Francisco, CA",
      "name": "Sarah Johnson",
      "notes": "VIP customer; prefers email communication",
      "social_instagram_handle": "sarah.lifestyle",
      "social_tiktok_handle": "sarah.creates",
      "social_x_handle": "sarah_j",
      "updated_at": "2026-01-20T14:22:15.000Z"
    },
    "review_link": {
      "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token",
      "query_string": "?cevoid.widget=reviews.product-review&cevoid.auth=example-signed-token",
      "search_params": {
        "cevoid.auth": "example-signed-token",
        "cevoid.widget": "reviews.product-review"
      }
    }
  },
  "id": "evt_m3p82kdq5xw7tz4c",
  "origin": {
    "flow": {
      "id": "wfl_q7v2m9x4k8d3h6b5",
      "name": "Post-purchase follow-up"
    },
    "trigger": "order.fulfilled"
  },
  "type": "product-review-request.created",
  "version": 1
}

Show all 158 linesShow fewer lines

versionnumberrequired

The version of this event type. A published version only gains fields, so ignore fields you do not use; a breaking change is a new version.

idstringrequired

Stable event id (evt_ plus 16 characters), also sent as the webhook-id header. Retries and manual replays send the same id, so ignore an event whose id you have already processed.

typestringrequired

What data describes. New types are added over time, and an endpoint on "All events" receives them, so ignore any type you do not handle.

created_atstring<date-time>required

When the event happened, as an ISO 8601 timestamp.

originobject

Why your endpoint received the event. Omitted when the event was forwarded without a Flow of your own.

origin properties

flowobjectrequired

The Flow that sent the event.

flow properties

idstringrequired

The Flow id, shown in the Flow URL.

namestringrequired

The Flow name at the time of sending.

triggerstringrequired

The event that started the Flow. One of order.fulfilled, order.delivered, product-review.submitted, company-review.submitted, product-review.replied, company-review.replied, upload.completed, post.approved, profile.program-joined, profile.program-left, tier.earned, reward.fulfilled, tier.evaluation-approaching, points.expiration-approaching.

dataobjectrequired

The resources the event carries, keyed by resource name. type decides which resources are included, and resources your plan does not include are left out.

data properties

orderobjectrequired

order properties

idstringrequired

Cevoid order ID.

ingestion_modestring

Processing mode of the latest order write. Historical mode suppresses automatic Flows. Live mode allows new lifecycle transitions to trigger Flows. Absent for orders without a live or historical mode. One of live, historical.

sourceobjectrequired

source properties

typestring

System that owns this order. Absent when the order has no connected source. One of SHOPIFY, WOOCOMMERCE, MYSTORE, NORDISK_EHANDEL, VISKAN, CENTRA, PUBLIC_API, OTHER.

connection_idstring

Stable source namespace for the order. Absent when the order has no connected source.

external_order_idstringrequired

Order identifier in the source system.

order_numberstring

Customer-facing order number.

buyerobject

Buyer identity. Absent when the order carries no buyer information.

buyer properties

emailstring

Buyer email as supplied by the source system.

external_customer_idstring

Customer identifier in the source system.

profile_idstring

Cevoid profile ID. Absent when no profile is linked to the order.

placed_atstring<date-time>required

ISO 8601 timestamp when the order was placed.

currencystringrequired

Three-letter uppercase ISO currency code.

moneyobjectrequired

money properties

totalnumberrequired

Current declared order total.

sub_totalnumberrequired

Current merchandise subtotal.

discountnumber

Current order-level discount total.

taxnumber

Current order-level tax total.

shippingnumber

Current order-level shipping total.

refundednumber

Cumulative refunded amount.

fulfillment_statusstringrequired

Current order fulfillment state. One of PENDING, PARTIALLY_FULFILLED, FULFILLED, DELIVERED.

financial_statusstringrequired

Current order payment state. One of PENDING, PAID, PARTIALLY_REFUNDED, REFUNDED.

fulfilled_atstring<date-time>

ISO 8601 timestamp when the order was fulfilled.

delivered_atstring<date-time>

ISO 8601 timestamp when the order was delivered.

cancelledbooleanrequired

Whether the order is cancelled.

cancelled_atstring<date-time>

ISO 8601 timestamp when the order was cancelled.

paid_atstring<date-time>

ISO 8601 timestamp when the order was paid.

last_refunded_atstring<date-time>

ISO 8601 timestamp of the most recent refund.

market_idstring

Cevoid market ID.

linesobject[]required

lines[] properties

external_line_idstringrequired

Stable line identifier within the source order.

product_idstring

Product identifier in the source catalog. Absent when the line names no product.

variant_idstring

Variant identifier in the source catalog.

skustring

Merchant SKU snapshot.

quantityintegerrequired

Absolute ordered quantity.

unit_pricenumberrequired

Price per unit in the order currency.

discountnumber

Discount allocated to this line.

refundnumber

Cumulative amount refunded for this line.

returned_unitsinteger

Absolute number of returned units.

fulfillment_statusstringrequired

Current fulfillment state for this line. One of PENDING, PARTIALLY_FULFILLED, FULFILLED, DELIVERED.

delivered_atstring<date-time>

ISO 8601 timestamp when this line was delivered.

removed_atstring<date-time>

Time the line was removed from the order.

created_atstring<date-time>required

ISO 8601 timestamp when Cevoid created the order.

updated_atstring<date-time>required

ISO 8601 timestamp when Cevoid last updated the order.

removed_atstring<date-time>

Time the order was deleted.

profileobject

profile properties

idstringrequired

Cevoid profile ID.

external_idstring

Identifier this profile carries in the workspace source system, when known.

namestring

Display name of the profile.

first_namestring

First name of the profile.

last_namestring

Last name of the profile.

emailstring

Email address for the profile.

avatar_urlstring

Profile image URL.

countrystring

Country code associated with the profile.

languagestring

Preferred language code associated with the profile.

locationstring

Free-form location associated with the profile.

social_instagram_handlestring

Instagram handle associated with the profile.

social_tiktok_handlestring

TikTok handle associated with the profile.

social_x_handlestring

X handle associated with the profile.

birthdaystring<date>

Birthday in YYYY-MM-DD format.

biostring

Profile biography text.

notesstring

Merchant notes about the profile.

created_atstring<date-time>required

ISO 8601 timestamp when the profile was created.

updated_atstring<date-time>required

ISO 8601 timestamp when the profile was last updated.

review_linkobjectrequired

review_link properties

full_urlstring<uri>required

query_stringstringrequired

search_paramsobjectrequired

productsobject[]required

products[] properties

productobjectrequired

review_linkobjectrequired

review_link properties

full_urlstring<uri>required

query_stringstringrequired

search_paramsobjectrequired

rating_linksobjectrequired

rating_links properties

1objectrequired

1 properties

full_urlstring<uri>required

query_stringstringrequired

search_paramsobjectrequired

2objectrequired

2 properties

full_urlstring<uri>required

query_stringstringrequired

search_paramsobjectrequired

3objectrequired

3 properties

full_urlstring<uri>required

query_stringstringrequired

search_paramsobjectrequired

4objectrequired

4 properties

full_urlstring<uri>required

query_stringstringrequired

search_paramsobjectrequired

5objectrequired

5 properties

full_urlstring<uri>required

query_stringstringrequired

search_paramsobjectrequired