Overview
Enrichment fetches additional data for each datapoint returned by the main Extract phase. For every extracted record, RWS Integration makes one or more secondary API requests and attaches the responses to the datapoint, so the rest of the integration can combine fields from both the original extraction and the enrichments. The flow becomes Extract → Enrichment → Transform → Load.When to use
Use enrichment when the main extraction returns records that are missing details available from a separate endpoint — for example, fetching comments for a post, line items for an order, or address details for a customer keyed by an ID in the main list.Configuration
Each enrichment is defined by:| Field | Description |
|---|---|
| Name | Key the response is stored under (e.g., comments) |
| Connection | Connection used for the request |
| Method | HTTP method (GET, POST, etc.) |
| Path | Endpoint path, which can include parameters like {{ parameterId }} |
| Enrichment query parameters | Provide the values for the parameters referenced in the path |
{{ name }}. The value can be defined in two ways:
| Type | Description |
|---|---|
| Fixed | A fixed value to be used as the query parameter |
| Business rule | A value computed with a JavaScript business rule |
Fixed value may embed {{ ... }} placeholders that are interpolated from the main extraction datapoint or another enrichment — e.g. {{ id }}. See Dynamic Parameters for more information.
Referencing other enrichments
By default every enrichment runs against the primary extraction datapoint. An enrichment can also depend on another enrichment’s response — useful when one request returns an ID needed to build the next request. Enable Has another enrichment as a dependency? and set the Enrichment name to the enrichment it depends on. You can then reference that enrichment’s response fields using dot notation:comments returns a post’s comments, a dependent enrichment can use its fields in query parameter values:
| Fixed value | To |
|---|---|
{{ comments[0].postId }} | postId |
{{ comments[0].email }} | commenterEmail |
Continue execution on error
Each enrichment has a Continue execution on error checkbox. When enabled, a failed enrichment request (HTTP 4xx or 5xx status) does not stop the integration — the datapoint continues through Transform and Load without that enrichment’s data. When disabled (the default), a failed enrichment request throws an error and interrupts the integration. Enable this when the enrichment is optional and you would rather deliver partial data than stop the integration.Accessing enrichment data
Enrichment responses are exposed in other sections of the integration underresources, keyed by enrichment name:
comments returning an array:
| From | To |
|---|---|
resources.comments[0].email | firstCommentEmail |
resources.comments[0].body | firstCommentText |
Related
Dynamic Parameters
Interpolate values into paths, headers, and request bodies
Integration with multiple extractions
Step-by-step guide to building an enrichment integration