From 4cd417f7de81b6c67eef075bc5eb0fd59e85678e Mon Sep 17 00:00:00 2001 From: Jaehyun Lim Date: Fri, 18 Sep 2026 14:40:04 -0700 Subject: [PATCH] [ENG-4255] docs(notifications): write.async.done sends `error` string instead of `errors` array `write.async.done` now reports failures as a single `error` string, like every other failure notification, instead of an `errors` array. Drop the empty array from the success examples (`error` is omitted when the write succeeds) and note that multi-record batch failures are joined into one string. Co-Authored-By: Claude Opus 5 --- src/notifications/notification-payloads.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/notifications/notification-payloads.mdx b/src/notifications/notification-payloads.mdx index 2d57f63d..3aa80b00 100644 --- a/src/notifications/notification-payloads.mdx +++ b/src/notifications/notification-payloads.mdx @@ -344,8 +344,7 @@ Note: `error` describes what went wrong during the triggered read. "consumerName": "John Doe", "objectName": "Account", "success": true, - "successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"], - "errors": [] + "successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"] } } ``` @@ -365,12 +364,13 @@ Note: `error` describes what went wrong during the triggered read. "consumerName": "John Doe", "objectName": "Account", "success": true, - "successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"], - "errors": [] + "successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"] } ``` -Note: For partial failures, `success` is `false` with both `successfulRecordIds` and `errors` populated. +Note: `error` is only present when the write failed. For partial failures, `success` is `false` with both +`successfulRecordIds` and `error` populated; when several records fail, their messages are joined into a +single string, for example `"field validation failed; duplicate record"`.