Webhooks allow the Prophy platform to send real-time notifications to your system when specific events occur. This enables you to seamlessly integrate Prophy functionality with your application without requiring constant polling for updates.
When a user performs certain actions in Prophy, such as selecting referees for a manuscript, Prophy can send HTTP POST requests to a webhook URL in your system. Your application can then process these notifications and update your databases or trigger appropriate workflows accordingly. The webhook will be sent within 10 seconds after the action is performed.
A user with Integrations admin quota can view and manage the Webhook URLs on the Integrations dashboard.
A separate Webhook API Key will be automatically generated for each Webhook URL.
You can configure multiple URLs, for example, when changing endpoints or rotating API Keys, all webhooks will be sent to all configured URLs.
The webhook will be sent as an HTTP POST request with an application/json body.
You can add HTTP Basic Auth by including it into the URL, for example https://login:[email protected]/webhooks/
| Field | Description |
|---|---|
|
action
string
|
Name of the performed action. Possible values for now are: mark_as_proposal_referee. |
|
timestamp
integer
|
UNIX timestamp when the action was performed. |
|
order
integer
|
A unique, incrementing identifier for the webhook event that indicates the precise sequence in which events occurred. This can be used to ensure events are processed in the correct chronological order. The order value is guaranteed to increase with each new webhook event. |
|
api_key
string
|
The Webhook API Key to verify that the request was sent by Prophy.
|
|
payload
object
|
The webhook payload will contain information about the action. Details will be described on the page of the corresponding webhook. |
Your server should respond with a 200 status code to indicate successful reception of the webhook. If your server responds with any other status code, Prophy will retry the webhook delivery with the following schedule:
| Retry number | Delay after last attempt |
|---|---|
| 1 | 2 mins |
| 2 | 4 mins |
| 3 | 8 mins |
| 4 | 16 mins |
| 5 | 32 mins |
| 6 | 64 mins |
| 7 | 128 mins |
| 8 | 256 mins |
| 9 | 512 mins |