Parse Customer.io Track API batch multi-status responses by jcpsimmons · Pull Request #3657 · segmentio/action-destinations

jcpsimmons · 2026-03-10T17:33:21Z

Parses Customer.io Track API batch responses into per-item MultiStatusResponse results so Segment can surface partial failures correctly.

Testing

Verified locally under Node 22.13.1:

TZ=UTC yarn cloud test --testPathPattern=src/destinations/customerio/__tests__/utils.test.ts ✅
./bin/run serve --destination=customerio -n boots successfully and exposes the Customer.io action routes ✅
End-to-end testing using the local server was completed ✅
Added unit tests for new functionality
Tested end-to-end using the local server
[If destination is already live] Tested for backward compatibility of destination. Note: New required fields are a breaking change.
[Segmenters] Tested in the staging environment
[If applicable for this change] Tested for regression with Hadron.

Security Review

No field definitions or credential handling were changed in this PR.

Reviewed all field definitions for sensitive data (API keys, tokens, passwords, client secrets) and confirmed they use type password

New Destination Checklist

Not applicable.

Extracted all action API versions to verioning-info.ts file. example

jcpsimmons · 2026-03-10T17:33:52Z

This draft is 1 of 3 upstream Customer.io PRs for CDP-4750.

Scope here: only Track API batch multi-status parsing in customerio/utils.ts plus focused parsing tests.

Not in this PR:

decimal timestamp normalization
preset/default-subscription parity

Companion drafts:

Preserve decimal Customer.io timestamps #3656 decimal timestamps
Align Customer.io preset subscriptions with reserved events #3655 preset/default-subscription parity

This supersedes the Track API parsing portion of the older combined draft #3654.

jcpsimmons · 2026-03-23T21:35:07Z

Hi @joe-ayoub-segment could I please have review on this and the other two PRs 🙏

joe-ayoub-segment

Hi @jcpsimmons,

Thanks for raising the PR for this change. It will really help customers with observability.

I left some comments for you to look at.
I didn't review all of the PR as i found it difficult to follow. Adding the types (see comments) will help me better understand the logic.

One final thing - please add proof of testing to the PR description.

show batch payloads being delivered
show error responses being returned correctly

Let me know if you have any questions or would like assistance.

best regards,
Joe

joe-ayoub-segment · 2026-03-25T05:38:09Z

packages/destination-actions/src/destinations/customerio/utils.ts

+  if (response?.status === 207 && responseBody) {
+    const parsedResults = parseTrackApiMultiStatusResponse(responseBody, batch.length)
+    if (parsedResults) {
+      return parsedResults
+    }
+  }
+
+  if (response?.status === 200 && responseBody) {
+    const parsedResults = parseTrackApiMultiStatusResponse(responseBody, batch.length)
+    if (parsedResults) {
+      return parsedResults
+    }
+  }


nit: Can we reduce the redundant code here?

Done, collapsed the two blocks into a single OR condition.

joe-ayoub-segment · 2026-03-25T05:40:46Z

packages/destination-actions/src/destinations/customerio/utils.ts

  const batch = options.map((opts) => buildPayload(opts))

-  return request(`${trackApiEndpoint(settings)}/api/${CUSTOMERIO_TRACK_API_VERSION}/batch`, {
+  const response = await request(`${trackApiEndpoint(settings)}/api/${CUSTOMERIO_TRACK_API_VERSION}/batch`, {


Can we add an expected response type to this?
For example:

const response = await request<CustomerIOBatchResponse>(`${trackApiEndpoint(settings)}/api/${CUSTOMERIO_TRACK_API_VERSION}/batch`, { method: 'POST', json { batch } })

Also, consider wrapping this request in a try catch so that you can properly populate errors in the multistatusResponse when the entire payload fails.

try {
const response = await request(${trackApiEndpoint(settings)}/api/${CUSTOMERIO_TRACK_API_VERSION}/batch, {
method: 'POST',
json { batch }
})
}
catch(err) {
const error as CustomerIOErrorResponse
// for each payload in the batch, do setErrorResponseAtIndex
}

Added. Renamed TrackApiResponse to CustomerIOBatchResponse and passed it as the generic: request<CustomerIOBatchResponse>(...). Also wrapped the whole thing in a try/catch per your other comment so failed requests populate every index with the error details.

Added. The catch block extracts the status and message from the error, then iterates over every item in the batch and calls setErrorResponseAtIndex with the original payload and sent JSON. If the whole request blows up, every item in the multi-status response reflects the failure.

joe-ayoub-segment · 2026-03-25T05:41:57Z

packages/destination-actions/src/destinations/customerio/utils.ts

    }
  })
+
+  const responseBody = getResponseBody(response)


Can we add a type to this too please?

Covered by the same rename. getResponseBody now returns CustomerIOBatchResponse | string | undefined and that flows through to parseTrackApiMultiStatusResponse.

joe-ayoub-segment · 2026-03-25T05:46:07Z

packages/destination-actions/src/destinations/customerio/utils.ts

+    const error = errorMap.get(i)
+
+    if (!error) {
+      multiStatusResponse.setSuccessResponseAtIndex(i, {


The contents of each multiStatusResponse item is passed to the UI for observability purposes.
So if possible we should populate body and sent values correctly:

msResponse.setSuccessResponseAtIndex(index, { status: 200, body: // this should be the original payload object sent to the perform function, sent: // this should be the actual JSON which was posted to your platform })

Good call. Threaded the original options array and the built batch array through to parseTrackApiErrors. Success responses now get body: options[i].payload (original payload from perform) and sent: batch[i] (the transformed JSON we posted).

joe-ayoub-segment · 2026-03-25T05:47:49Z

packages/destination-actions/src/destinations/customerio/utils.ts

+      continue
+    }
+
+    multiStatusResponse.setErrorResponseAtIndex(i, {


Similarly to successful responses, we should try and populate error responses with correct details.

msResponse.setErrorResponseAtIndex(index, { status: 400, errortype, errormessage, body: // this should be the original payload object sent to the perform function, sent: // this should be the actual JSON which was posted to your platform })

Same fix, error responses now also get body: options[i].payload and sent: batch[i].

joe-ayoub-segment · 2026-03-25T05:48:15Z

packages/destination-actions/src/destinations/customerio/utils.ts

+  }
+}
+
+function getResponseBody(response: RequestResponse): unknown {


Please define a proper response type for this function.

Done. Returns CustomerIOBatchResponse | string | undefined now.

joe-ayoub-segment · 2026-03-25T06:00:35Z

Hi Josh, Apologies for the slow response. I've left some comments for you to address in the PR. implementing multistatusResponses is a little tricky, so I'm happy to jump on a call if needed. The main thing is to correctly type requests and responses so that everybody looking at the code can understand the data structures being handled. Also it would be useful to wrap the request in a try catch, and return a multistatusResponse for the error case. Please ping me if you have any questions or would like assistance. Best regards, Joe

…

On Mon, Mar 23, 2026 at 9:35 PM Dr. Josh C. Simmons < ***@***.***> wrote: *jcpsimmons* left a comment (segmentio/action-destinations#3657) <https://urldefense.com/v3/__https://github.com/segmentio/action-destinations/pull/3657*issuecomment-4113844014__;Iw!!NCc8flgU!YIx_3NaCz1YJCW8M3MIj047uHVLiP_R9Gf-cxZc9SDayaKlSXnRDW_D_3Y9M6p9bnn0-ApFkWfx-jEiyW2PnCMK5rw$> Hi @joe-ayoub-segment <https://urldefense.com/v3/__https://github.com/joe-ayoub-segment__;!!NCc8flgU!YIx_3NaCz1YJCW8M3MIj047uHVLiP_R9Gf-cxZc9SDayaKlSXnRDW_D_3Y9M6p9bnn0-ApFkWfx-jEiyW2MGwbRqhA$> could I please have review on this and the other two PRs 🙏 — Reply to this email directly, view it on GitHub <https://urldefense.com/v3/__https://github.com/segmentio/action-destinations/pull/3657?email_source=notifications&email_token=AK2F3MDJNXORNUH2H3UH5BD4SGU2FA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIMJRGM4DINBQGE2KM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM*issuecomment-4113844014__;Iw!!NCc8flgU!YIx_3NaCz1YJCW8M3MIj047uHVLiP_R9Gf-cxZc9SDayaKlSXnRDW_D_3Y9M6p9bnn0-ApFkWfx-jEiyW2O7u9S9Cw$>, or unsubscribe <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AK2F3MG7EZCXGGDGPVQMDAL4SGU2FAVCNFSM6AAAAACWNKZAI6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DCMJTHA2DIMBRGQ__;!!NCc8flgU!YIx_3NaCz1YJCW8M3MIj047uHVLiP_R9Gf-cxZc9SDayaKlSXnRDW_D_3Y9M6p9bnn0-ApFkWfx-jEiyW2OyDGZ5NA$> . You are receiving this because you were mentioned.Message ID: ***@***.***>

… try/catch - Collapse duplicate 200/207 status blocks into single OR condition - Rename TrackApiResponse to CustomerIOBatchResponse and add as request generic - Add return type to getResponseBody - Thread original payloads and built batch through to populate body/sent in multi-status responses - Wrap batch request in try/catch to handle full payload failures

jcpsimmons · 2026-04-01T20:30:14Z

HI @joe-ayoub-segment thank you for that feedback - I've addressed could I please have a re-review?

Parse Customer.io Track API batch multi-status responses

a36f1ab

github-actions bot added mode:cloud team:external labels Mar 10, 2026

This was referenced Mar 10, 2026

Preserve decimal Customer.io timestamps #3656

Open

Align Customer.io preset subscriptions with reserved events #3655

Open

Sync generic Customer.io destination fixes upstream #3654

Closed

jcpsimmons marked this pull request as ready for review March 10, 2026 17:38

jcpsimmons requested a review from a team as a code owner March 10, 2026 17:38

github-actions bot requested a review from joe-ayoub-segment March 10, 2026 17:38

jcpsimmons marked this pull request as draft March 10, 2026 17:39

jcpsimmons marked this pull request as ready for review March 10, 2026 17:50

joe-ayoub-segment self-assigned this Mar 11, 2026

joe-ayoub-segment added the partner-eng-review (cloud) label Mar 11, 2026

joe-ayoub-segment requested changes Mar 25, 2026

View reviewed changes

jcpsimmons force-pushed the cdp-4750-cio-track-api-multistatus branch from 2244302 to 8be62ad Compare March 30, 2026 21:34

Merge branch 'main' into cdp-4750-cio-track-api-multistatus

748c057

Conversation

jcpsimmons commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing

Security Review

New Destination Checklist

Uh oh!

jcpsimmons commented Mar 10, 2026

Uh oh!

jcpsimmons commented Mar 23, 2026

Uh oh!

joe-ayoub-segment left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joe-ayoub-segment commented Mar 25, 2026 via email

Uh oh!

jcpsimmons commented Apr 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jcpsimmons commented Mar 10, 2026 •

edited

Loading