diff --git a/content/en/documentation/for-contributors/control-plane/entities/_index.md b/content/en/documentation/for-contributors/control-plane/entities/_index.md index 1382b8e..f3d42de 100644 --- a/content/en/documentation/for-contributors/control-plane/entities/_index.md +++ b/content/en/documentation/for-contributors/control-plane/entities/_index.md @@ -1198,6 +1198,8 @@ Currently, we support the following events: - `transfer.process.resuming` - `transfer.process.completed` - `transfer.process.terminated` +- `transfer.process.dataflow.errored`: the data plane reported a non-recoverable error of the data flow; the transfer + process doesn't change state The connector's event dispatcher will send invoke the webhook specified in the `uri` field passing the event payload as JSON object. diff --git a/content/en/documentation/for-contributors/data-plane/data-plane-signaling/_index.md b/content/en/documentation/for-contributors/data-plane/data-plane-signaling/_index.md index beb0d6c..ca08c81 100644 --- a/content/en/documentation/for-contributors/data-plane/data-plane-signaling/_index.md +++ b/content/en/documentation/for-contributors/data-plane/data-plane-signaling/_index.md @@ -134,8 +134,10 @@ The data plane notifies the control plane through the Signaling API, a dedicated - `POST /transfers/{transferId}/dataflow/started`: an asynchronous `start` is done, with the data address if any; - `POST /transfers/{transferId}/dataflow/completed`: the data flow is complete, the control plane completes the transfer process and notifies the counter-party; -- `POST /transfers/{transferId}/dataflow/errored`: the data flow failed. The control plane logs the error, the transfer - process doesn't change state. +- `POST /transfers/{transferId}/dataflow/errored`: the data flow failed for good. As defined by DPS, the transfer + process doesn't change state and the counter-party is not notified: the control plane logs the error and emits the + event `transfer.process.dataflow.errored`, with the error, so that callbacks or operators can decide how to recover, + e.g. by terminating the transfer process or starting a new one. The data plane must be configured with the URL of this API: the control plane doesn't send it in the `prepare` and `start` messages.