Skip to content

docs: add errored transfer process event dps #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wolf4ood merged 1 commit into from
Nov 5, 2026
Merged

docs: add errored transfer process event dps #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/en/documentation/for-contributors/control-plane/entities/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 4 additions & 2 deletions ...ent/en/documentation/for-contributors/data-plane/data-plane-signaling/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading