6.2.Project Status Update
Partners may provide Prodege with a webhook URL that can be called each time a project’s status is updated in the Prodege system. The webhook will be called in as close to real time as possible.
| Project Status Update Webhook Parameters – POST | |||
| Parameter Name | Parameter Type | Description | |
| data | Array | Details related to the project status update. See elements model and example below. | |
| signature | String | The signature of your request (see Authentication). | |
| data Model | |||
| Property Name | Property Type | Description | |
| event_id | String | The id that uniquely identifies the event. | |
| event_time | String | The timestamp of the event (Pacific Time). | |
| project_id | Numeric | The id that uniquely identifies this project. | |
| status | String | The status of the project (e.g. LIVE, PAUSED, PENDING_COMPLETE, COMPLETE, INVOICED, DELETED). | |
| rejection_note | String | Present only when the update_reason is DISABLED_BY_RECONCILIATION_REJECTION. This represents the note from support regarding the reconciliation rejection. | |
| reconciliation_note | String | May be present when a project status is updated to Pending Complete or when updated from any status (even from Pending Complete) to Complete with the update_reason COMPLETE_RECONCILIATION (903). | |
| required_cpi | String | Present only when the update_reason is DISABLED_BY_CPI_REALITY_CHECK. This represents the CPI that must be accepted in order to resume the project. | |
| update_reason | Numeric | The reason for the project status change. See possible values below. | |
| description | String | Description of the update_reason. See possible values below. | |
| update_reason | Description |
| 113 | Disabled due to reaching max clicks |
| 156 | Disabled to due to no more available unique links |
| 158 | Disabled due to reaching sample size |
| 160 | Disabled by Real Time Pricing |
| 207 | Set to Paused due to inactivity |
| 209 | Set to Complete due to inactivity |
| 222 | Disabled due to high drop off rate |
| 244 | Disabled by support agent |
| 902 | Project is set to Pending Complete after a reconciliation attempt |
| 903 | Project reconciliation is complete and the status of a project is set to Complete |
| 999 | Other |
data example:
{
"event_id": "644b075404443f2a3c77c7cb",
"event_time": "2023-04-27 16:37:56",
"status": "PAUSED",
"update_reason": 158,
"description": "DISABLED_BY_HAS_REACHED_SAMPLE_SIZE",
"project_id": 29303649
}
Expected Response
If a 200 status code is received, the call should be considered successful and it should not be retried.
If a 200 status code is received with a specific message (see below), the call should be considered unsuccessful but it should NOT be retried.
{
"success": false,
"error": {
"event_id": "63e174296722563b9cc28d96",
"error": "Some descriptive error message"
}
}
If a 500 status code is received, the call should be considered unsuccessful and it should be retried up to 3 times.
If a 400 status code is received, the call should be considered unsuccessful and it should NOT be retried.
Help Guide Powered by Documentor