mark_as_proposal_referee webhook is triggered when a user marks or unmarks a candidate as a referee for a manuscript in Prophy.
This webhook allows you to automatically update referee selections in your system, ensuring consistency between Prophy and your platform.
This webhook is sent in the following scenarios:
The payload contains info about the list of marked referees after the action is performed.
| Field | Description |
|---|---|
|
version
integer
|
Payload version number for tracking changes in the payload structure |
|
manuscript_id
integer
|
Manuscript ID in the Prophy database |
|
origin_id
nullable string
|
Client-side ID of the manuscript |
|
candidates
array of objects
|
List of marked candidates |
|
authors_groups_settings
nullable object
|
Authors Groups settings according to the folder's Referee Finder settings |
| Field | Description |
|---|---|
|
name
string
|
Author's full name |
|
first_name
string
|
Author's first name |
|
last_name
string
|
Author's last name |
|
middle_name
nullable string
|
Author's middle name |
|
suffix
nullable string
|
Name suffix like jr, sr |
|
author_id
integer
|
Author's ID in the Prophy database |
|
email
nullable string
|
Author's email |
|
orcid
nullable string
|
Author's ORCID |
|
affiliation
nullable string
|
Author's most recent affiliation |
|
articlesCount
integer
|
Number of articles published by the author |
|
citationsCount
integer
|
Number of citations for the author's articles |
|
hIndex
integer
|
Author's h-index |
|
score
float
|
Relevance score for this candidate (higher is more relevant). The value reflects the state at the time the candidate was first marked. |
|
relevant_concepts
array of strings
|
A list of candidate's concepts relevant to the proposal. The value reflects the state at the time the candidate was first marked. |
|
url
string
|
URL to the author's profile in Prophy |
|
authors_groups
array of objects
|
List of Authors Groups that contain this author, according to folder's Referee Finder settings |
|
marked
boolean
|
Indicates if the candidate is marked as a referee.
Always true because webhook returns only marked candidates.
|
|
marked_by
string
|
Email of a user who marked the candidate |
|
coauth_conflicts
object
|
v6
Information about co-authorship conflict of interest of the candidate. The value reflects the state at the time the candidate was first marked. |
|
aff_conflicts
object
|
v6
Information about common affiliations between candidate and the manuscript's authors. The value reflects the state at the time the candidate was first marked. |
|
retracted_articles
object
|
v6
Information about candidate's retracted articles. The value reflects the state at the time the candidate was first marked. |
|
referenced_articles
object
|
v6
Information about candidate's publications referenced in the manuscript's bibliography. The value reflects the state at the time the candidate was first marked. |
|
external_coi
object
|
v6
Information about candidate's conflict of interest, provided via client uploaded data. The value reflects the state at the time the candidate was first marked. |
This field indicates the Authors Groups the candidate belongs to, according to the folder's Referee Finder settings. If the settings do not specify Authors Groups, the field will contain an empty list.
| Field | Description |
|---|---|
|
group_id
integer
|
Authors Group ID in the Prophy database |
|
client_id
nullable string
|
Client-side author ID inside the Authors Group |
| Field | Description |
|---|---|
|
exists
boolean
|
Indicates if the candidate was coauthor with any of the manuscript authors |
| Field | Description |
|---|---|
|
exists
boolean
|
Indicates if the candidate has common affiliation with any of the manuscript authors |
| Field | Description |
|---|---|
|
exists
boolean
|
Indicates if the candidate has any retracted articles |
| Field | Description |
|---|---|
|
exists
boolean
|
Indicates if the candidate is referenced in the manuscript's bibliography |
| Field | Description |
|---|---|
|
exists
boolean
|
Indicates if the candidate was flagged as having a conflict of interest with this manuscript by the client via uploaded data. |
If the folder's Referee Finder settings specify the Authors Groups, then this field will indicate the Authors Groups and their effect on the search results.
| Field | Description |
|---|---|
|
authors_groups
array of objects
|
A list of Authors Groups for the candidates |
|
effect
string
|
highlight to indicate that the authors belong to the Authors Group. limit_to to search candidates only in Authors Groups. |
| Field | Description |
|---|---|
|
id
integer
|
Authors Group ID in the Prophy database |
|
name
string
|
Authors Group name |
|
label
nullable string
|
Authors Group label |
Here's an example of a complete webhook body when a user marks a candidate as a referee:
{
"action": "mark_as_proposal_referee",
"timestamp": 1665565152,
"order": 186,
"api_key": "test000",
"payload": {
"version": 6,
"manuscript_id": 1,
"origin_id": "pr-0156",
"authors_groups_settings": {
"authors_groups": [
{
"id": 35,
"label": "winter-experts",
"name": "2023-winter-experts"
},
{
"id": 55,
"label": "summer-experts",
"name": "2023-summer-experts"
}
],
"effect": "highlight"
},
"candidates": [
{
"url": "https://www.prophy.ai/author/1/martin-dotson",
"author_id": 1,
"name": "Martin von Dotson",
"first_name": "Martin",
"middle_name": null,
"last_name": "von Dotson",
"suffix": null,
"email": "martin.dotson@.example.com",
"orcid": "0000-0000-0000-0001",
"hIndex": 85,
"articlesCount": 329,
"citationsCount": 22858,
"score": 4.95,
"marked": true,
"affiliation": "University of Lisbon, Lisbon, Portugal",
"relevant_concepts": [
"central drift chamber",
"Branching ratio",
"BELLE II",
"Monte Carlo method",
"KEKB accelerator",
"signal region",
"Lepton flavour violation",
"Neutral pion",
"signal yield",
"Kaon",
"Pseudoscalar meson",
"silicon vertex detector",
"Pion",
"Decay width",
"Invariant mass"
],
"authors_groups": [
{
"client_id": "EX001",
"group_id": 35
},
{
"client_id": "EX001",
"group_id": 55
}
],
"marked_by": "example@example.com",
"coauth_conflicts": {
"exists": false
},
"aff_conflicts": {
"exists": false
},
"retracted_articles": {
"exists": false
},
"referenced_articles": {
"exists": false
},
"external_coi": {
"exists": false
}
},
{
"url": "https://www.prophy.ai/author/2/mea-walton",
"author_id": 2,
"name": "Mea Cynthia Walton",
"first_name": "Mea",
"middle_name": "Cynhtia",
"last_name": "Walton",
"suffix": null,
"email": "mea.walton@example.com",
"orcid": "0000-0000-0000-0002",
"hIndex": 69,
"articlesCount": 258,
"citationsCount": 13608,
"score": 3.86,
"marked": true,
"affiliation": "National Institute for Nuclear Physics, Rome, Italy",
"relevant_concepts": [
"VEPP-2000",
"Calorimetry instrument",
"detection efficiency",
"Invariant mass",
"Collider",
"background event",
"Integrated luminosity",
"Positron annihilation"
],
"authors_groups": [
{
"client_id": "EX002",
"group_id": 35
}
],
"marked_by": "example@example.com",
"coauth_conflicts": {
"exists": false
},
"aff_conflicts": {
"exists": false
},
"retracted_articles": {
"exists": false
},
"referenced_articles": {
"exists": false
},
"external_coi": {
"exists": false
}
},
{
"url": "https://www.prophy.ai/author/3/cristiano-fuentes",
"author_id": 3,
"name": "Cristiano Fuentes Jr.",
"first_name": "Cristiano",
"middle_name": null,
"last_name": "Fuentes",
"suffix": "Jr.",
"email": "cristiano.fuentes@example.com",
"orcid": "0000-0000-0000-0003",
"hIndex": 77,
"articlesCount": 227,
"citationsCount": 19614,
"score": 0.67,
"marked": true,
"affiliation": "National Research Council, Rome, Italy",
"relevant_concepts": [
"center-of-mass energy",
"hadron barrel calorimeter",
"DELPHI detector",
"Invariant mass",
"Standard Model expectation",
"Muon",
"background event",
"cross section measurement"
],
"authors_groups": [
{
"client_id": "EX003",
"group_id": 35
}
],
"marked_by": "example@example.com",
"coauth_conflicts": {
"exists": false
},
"aff_conflicts": {
"exists": false
},
"retracted_articles": {
"exists": false
},
"referenced_articles": {
"exists": false
},
"external_coi": {
"exists": false
}
}
]
}
}
Run the following curl request to verify that your webhook endpoint is accepting the data that the Prophy will send.
Replace <webhook-url> with the URL you want to send webhook to.
curl -X POST <webhook-url> \
-H "Content-Type: application/json" \
-d '{
"test": true,
"action": "mark_as_proposal_referee",
"timestamp": 1665565152,
"order": 186,
"api_key": "test000",
"payload": {
"version": 6,
"manuscript_id": 1,
"origin_id": "pr-0156",
"authors_groups_settings": {
"authors_groups": [
{
"id": 35,
"label": "winter-experts",
"name": "2023-winter-experts"
},
{
"id": 55,
"label": "summer-experts",
"name": "2023-summer-experts"
}
],
"effect": "highlight"
},
"candidates": [
{
"url": "https://www.prophy.ai/author/1/martin-dotson",
"author_id": 1,
"name": "Martin von Dotson",
"first_name": "Martin",
"middle_name": null,
"last_name": "von Dotson",
"suffix": null,
"email": "martin.dotson@.example.com",
"orcid": "0000-0000-0000-0001",
"hIndex": 85,
"articlesCount": 329,
"citationsCount": 22858,
"score": 4.95,
"marked": true,
"affiliation": "University of Lisbon, Lisbon, Portugal",
"relevant_concepts": [
"central drift chamber",
"Branching ratio",
"BELLE II",
"Monte Carlo method",
"KEKB accelerator",
"signal region",
"Lepton flavour violation",
"Neutral pion",
"signal yield",
"Kaon",
"Pseudoscalar meson",
"silicon vertex detector",
"Pion",
"Decay width",
"Invariant mass"
],
"authors_groups": [
{
"client_id": "EX001",
"group_id": 35
},
{
"client_id": "EX001",
"group_id": 55
}
],
"marked_by": "example@example.com",
"coauth_conflicts": {
"exists": false
},
"aff_conflicts": {
"exists": false
},
"retracted_articles": {
"exists": false
},
"referenced_articles": {
"exists": false
},
"external_coi": {
"exists": false
}
},
{
"url": "https://www.prophy.ai/author/2/mea-walton",
"author_id": 2,
"name": "Mea Cynthia Walton",
"first_name": "Mea",
"middle_name": "Cynhtia",
"last_name": "Walton",
"suffix": null,
"email": "mea.walton@example.com",
"orcid": "0000-0000-0000-0002",
"hIndex": 69,
"articlesCount": 258,
"citationsCount": 13608,
"score": 3.86,
"marked": true,
"affiliation": "National Institute for Nuclear Physics, Rome, Italy",
"relevant_concepts": [
"VEPP-2000",
"Calorimetry instrument",
"detection efficiency",
"Invariant mass",
"Collider",
"background event",
"Integrated luminosity",
"Positron annihilation"
],
"authors_groups": [
{
"client_id": "EX002",
"group_id": 35
}
],
"marked_by": "example@example.com",
"coauth_conflicts": {
"exists": false
},
"aff_conflicts": {
"exists": false
},
"retracted_articles": {
"exists": false
},
"referenced_articles": {
"exists": false
},
"external_coi": {
"exists": false
}
},
{
"url": "https://www.prophy.ai/author/3/cristiano-fuentes",
"author_id": 3,
"name": "Cristiano Fuentes Jr.",
"first_name": "Cristiano",
"middle_name": null,
"last_name": "Fuentes",
"suffix": "Jr.",
"email": "cristiano.fuentes@example.com",
"orcid": "0000-0000-0000-0003",
"hIndex": 77,
"articlesCount": 227,
"citationsCount": 19614,
"score": 0.67,
"marked": true,
"affiliation": "National Research Council, Rome, Italy",
"relevant_concepts": [
"center-of-mass energy",
"hadron barrel calorimeter",
"DELPHI detector",
"Invariant mass",
"Standard Model expectation",
"Muon",
"background event",
"cross section measurement"
],
"authors_groups": [
{
"client_id": "EX003",
"group_id": 35
}
],
"marked_by": "example@example.com",
"coauth_conflicts": {
"exists": false
},
"aff_conflicts": {
"exists": false
},
"retracted_articles": {
"exists": false
},
"referenced_articles": {
"exists": false
},
"external_coi": {
"exists": false
}
}
]
}
}'