This event occurs when a ServicingAction
advances in status from IN_PROGRESS
to WAITING_FOR_CONSUMER_CONFIRMATION
. The Pull
it belongs to will also be in a WAITING_FOR_CONSUMER_CONFIRMATION
state as it cannot proceed until confirmation is supplied.
If a Pull
has three ServicingActions
, you will receive three WAITING_FOR_CONSUMER_CONFIRMATION
webhooks requests, one each time an action is waiting for confirmation.
Webhook Request Format
The webhook is a POST request with a JSON body that will look like the following:
{
"widget_id": "<WIDGET_ID>",
"team_id": "<TEAM_ID>",
"pull_id": "<PULL_ID>",
"status": "WAITING_FOR_CONSUMER_CONFIRMATION",
"meta_data": {... developer-supplied JSON-serializable metadata ...},
"event_type": "SERVICING_WAITING_FOR_CONSUMER_CONFIRMATION",
"account_identifier": "<ACCOUNT_IDENTIFIER>",
"is_monitored": false,
"data": {
"servicing_action_id": "<SERVICING_ACTION_ID>", // Returned with the WAITING_FOR_CONSUMER_CONFIRMATION event. servicing_action_id of the `ServicingAction` that is awaiting confirmation.
}
}
Data key | Data description |
---|---|
servicing_action_id | The ID for the ServicingAction that is awaiting confirmation. |
You may use GET /servicings/:servicingActionId to get the confirmation_data
available for the ServicingAction
.