These two review operations are available only through the Rhythm API. You will not find a Console or Portal screen for either operation, so use this reference to understand what each one does and where it does not provide a complete solution.
The Operations
| Operation | What it does | What to know before you use it |
|---|---|---|
| List an event's reviews | Returns reviews for one event you identify | The response includes only each review's status and event. It does not include the reviewer, abstract, or other review details, so do not use it as a full export of an event's reviews. |
| Send a review assignment email with your own template | Emails the reviewer using a template you include in the request, instead of the wording saved on the review process | The published request asks for the review as plain text, but the operation actually needs the full review record as an object so it can find the abstract and reviewer. A caller that follows the published request format cannot use this operation successfully today. |
How to Read This
Both operations are available only to callers of the Rhythm API. You cannot open them from a menu, button, or Portal page.
Use the review-listing operation only for a status count or similar rollup. It does not return enough detail for reporting, so use the Console's review tools when you need complete review records.
The assignment-email operation is meant to let an integration send a review assignment notice with different wording than the review process's saved template. Because the operation cannot be called successfully as documented, treat it as unavailable until Rhythm publishes a working request format.
When you build a template for this operation, remember that a merge field for an array or list, such as a set of co-authors, is not written like a plain field. Use Handlebars iteration syntax, such as {{#each collection}} ... {{/each}}, to render each item.
Applicability
These operations apply only to accounts that use Events abstract reviews and have API integrations built directly against Rhythm's API. Staff who work entirely in the Console do not need either operation.
The Console's review screens return complete review information. The Console also sends assignment emails using the review process's saved template.
Related
Search, filter, and act on reviews directly in the Console instead of through these operations. Manage the wording of review notification emails from the review process itself.