Skip to content
Get API key (opens in a new tab)

company-review-request.created

Sent when a Flow's Company review request action sends to a webhook, with the link to the review form and one link per star rating.

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

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

When it fires

  • Each time a Flow's Company review request action runs with a webhook as its delivery target.
  • data.subject is the order or product review that started the request, as its type and id.
  • data.review_link opens the review form. data.rating_links has the same link for each star rating from 1 to 5, with its rating parameter set to that number.

Receive it

In a Flow on Order fulfilled, Order delivered or Product review submitted, add the Company 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": {
    "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"
    },
    "rating_links": {
      "1": {
        "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=1",
        "query_string": "?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=1",
        "search_params": {
          "cevoid.auth": "example-signed-token",
          "cevoid.widget": "reviews.company-review",
          "rating": "1"
        }
      },
      "2": {
        "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=2",
        "query_string": "?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=2",
        "search_params": {
          "cevoid.auth": "example-signed-token",
          "cevoid.widget": "reviews.company-review",
          "rating": "2"
        }
      },
      "3": {
        "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=3",
        "query_string": "?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=3",
        "search_params": {
          "cevoid.auth": "example-signed-token",
          "cevoid.widget": "reviews.company-review",
          "rating": "3"
        }
      },
      "4": {
        "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=4",
        "query_string": "?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=4",
        "search_params": {
          "cevoid.auth": "example-signed-token",
          "cevoid.widget": "reviews.company-review",
          "rating": "4"
        }
      },
      "5": {
        "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=5",
        "query_string": "?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token&rating=5",
        "search_params": {
          "cevoid.auth": "example-signed-token",
          "cevoid.widget": "reviews.company-review",
          "rating": "5"
        }
      }
    },
    "review_link": {
      "full_url": "https://shop.example.com/pages/reviews?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token",
      "query_string": "?cevoid.widget=reviews.company-review&cevoid.auth=example-signed-token",
      "search_params": {
        "cevoid.auth": "example-signed-token",
        "cevoid.widget": "reviews.company-review"
      }
    },
    "subject": {
      "id": "ord_abc123",
      "type": "order"
    }
  },
  "id": "evt_m3p82kdq5xw7tz4c",
  "origin": {
    "flow": {
      "id": "wfl_q7v2m9x4k8d3h6b5",
      "name": "Post-purchase follow-up"
    },
    "trigger": "order.fulfilled"
  },
  "type": "company-review-request.created",
  "version": 1
}
Show all 94 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
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.

subjectobjectrequired
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