> For the complete documentation index, see [llms.txt](https://docs.chord.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chord.co/activate/event-streaming/destinations/attribution-and-affiliate/impact/impact-server.md).

# Impact server

Impact is an affiliate and partnership management platform that tracks conversions and page loads for partner attribution. This destination sends events from Chord's servers to Impact's tracking APIs. There is no browser component. For the browser version, see [Impact browser](/activate/event-streaming/destinations/attribution-and-affiliate/impact/impact-browser.md).

## Getting started

You need your Impact campaign ID. To send conversions you also need your Account SID and API Key. Find both in your Impact account settings. Page loads don't need them.

## Settings

* **Destination Name** (required): a name to tell this destination apart.
* **Campaign ID** (optional): your Impact program or campaign ID.
* **Account SID** (optional): your Impact account SID. Required for conversion events.
* **API Key** (optional): your Impact API key. Required for conversion events.
* **Event Type ID** (optional): a custom event type ID sent with conversion events.
* **Enable Page Events** (optional): forwards page events to Impact as page loads. Off by default. The two settings below also depend on it. See the warning after this list.
* **Enable Identify Events** (optional): forwards identify events as page loads. Off by default.
* **Enable All Track Events** (optional): forwards all other track events as page loads. Off by default.
* **Event Name** (optional; first list, described as custom event names to trigger conversions): event names to treat as conversions, in addition to `Order Complete` and `Order Completed`, which are always included. Empty by default.
* **Event Name** (optional; second list, described as custom event names to trigger page load tracking): event names to treat as page loads, in addition to `Page Load`, which is always included. Empty by default.
* **Custom Parameter Mapping** (optional): adds your own parameters to every Impact payload. For each row, enter the Impact parameter name in the first column and the event path in dot notation in the second. For example, `Note` and `properties.note`. See the note below about the column labels.
* **Custom Product Field Mapping** (optional): adds or overrides item fields on each product. For each row, enter the Impact item field in the first column and the product field in the second. For example, `ItemColor` and `color`.
* **Consent Requirements** (optional): the consent categories a visitor must accept before Chord sends data to this destination. See [Consent](/activate/event-streaming/consent.md).

Both event name lists are labeled **Event Name** in the form. Tell them apart by their descriptions. Event names are not case-sensitive.

{% hint style="warning" %}
**Enable Identify Events** and **Enable All Track Events** only send data when **Enable Page Events** is also on. With **Enable Page Events** off, Chord drops every page load, whichever setting produced it.
{% endhint %}

{% hint style="info" %}
The form labels the two mapping columns **Source Field** and **Impact Field** (or **Impact Item Field**). This destination reads the first column as the Impact name and the second column as the source, as described above.
{% endhint %}

## Connect

Add **Impact** from the destination catalog, using the settings above. See [Connect a destination](/activate/event-streaming/connect-a-destination.md) for the full steps.

## Event mapping

| Chord event                                                                            | Impact event | Notes                                                                                                      |
| -------------------------------------------------------------------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------- |
| `page`                                                                                 | Page Load    | Only sent when **Enable Page Events** is on. Impact API: PageLoad                                          |
| [`Order Completed`](/collect-data/tracking-plan/order-completed.md) / `Order Complete` | Conversion   | Always a conversion. Add more conversion names with the first **Event Name** list. Impact API: Conversions |
| Any event named in the second **Event Name** list, or named `Page Load`                | Page Load    | Only sent when **Enable Page Events** is on. Impact API: PageLoad                                          |
| `identify`                                                                             | Page Load    | Only sent when **Enable Identify Events** and **Enable Page Events** are on. Impact API: PageLoad          |
| *(any other track event)*                                                              | Page Load    | Only sent when **Enable All Track Events** and **Enable Page Events** are on. Impact API: PageLoad         |

Chord checks the event name against the conversion names first. An event that matches them is a conversion even if its type is `page`. All other events are skipped.

## Common fields (all events)

These fields are included in both Page Load and Conversion payloads.

| Chord source (priority order)                                                                                                                                                                                                                | Impact field        | Notes                                               |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | --------------------------------------------------- |
| Configured Campaign ID > `CampaignId` / `campaignId` on the event or in `properties`                                                                                                                                                         | `CampaignId`        |                                                     |
| `context.page.url` > `properties.url` > `context.page.referrer` > `properties.referrer` > `PageUrl` / `pageUrl` on the event or in `properties`                                                                                              | `PageUrl`           | Falls back to the referrer if there is no URL       |
| `context.page.referrer` > `properties.referrer` > `ReferringUrl` / `referringUrl` on the event or in `properties`                                                                                                                            | `ReferringUrl`      |                                                     |
| `timestamp`                                                                                                                                                                                                                                  | `EventDate`         | Sent as the event's timestamp                       |
| `anonymousId`                                                                                                                                                                                                                                | `CustomProfileId`   | Primary attribution key                             |
| `userId`                                                                                                                                                                                                                                     | `CustomerId`        |                                                     |
| `properties.email` > `properties.emailAddress` > `context.traits.email` > `traits.email`                                                                                                                                                     | `CustomerEmail`     | Trimmed, lowercased and SHA-1 hashed before sending |
| `requestIp` > `context.ip`                                                                                                                                                                                                                   | `IpAddress`         |                                                     |
| `context.userAgent` > `context.user_agent`                                                                                                                                                                                                   | `UserAgent`         |                                                     |
| `context.device.manufacturer`                                                                                                                                                                                                                | `DeviceMfr`         |                                                     |
| `context.device.model`                                                                                                                                                                                                                       | `DeviceModel`       |                                                     |
| `context.app.name`                                                                                                                                                                                                                           | `AppName`           |                                                     |
| `context.app.namespace`                                                                                                                                                                                                                      | `AppPackage`        |                                                     |
| `context.app.version`                                                                                                                                                                                                                        | `AppVer`            |                                                     |
| *(hardcoded)* `"ChordCDPCustom"`                                                                                                                                                                                                             | `IntegrationSource` |                                                     |
| URL param `irclickid` / `clickid` / `im_ref` > `context.clientIds.irclickid` > `context.clientIds.im_ref` > `context.clientIds.impact` > `context.referrer.id` (when type is `"impactradius"`) > `properties.ClickId` / `properties.clickId` | `ClickId`           | See [Click ID attribution](#click-id-attribution)   |

For the fields that list an Impact-style name (such as `PageUrl`), Chord uses the Chord source first and the Impact-style name only as a fallback.

Fields with `undefined`, `null`, empty string or `"undefined"` values are removed from the payload before sending. Custom parameters set in **Custom Parameter Mapping** are resolved with dot notation against the raw event and added to the payload. They are added after the fields above, so a custom parameter with the same name replaces the field.

## Page Load

Fires a page load event to Impact's PageLoad API.

**API call:** `POST https://trkapi.impact.com/PageLoad`

Only the common fields above are sent. No additional attributes.

## Order Completed

Fires a conversion event to Impact's Conversions API.

**API call:** `POST https://api.impact.com/Advertisers/{accountSid}/Conversions.json` (form-encoded, Basic Auth)

**Order-level fields**

| Chord source (priority order)                                                                                                                                                                          | Impact field                | Notes                                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------- | --------------------------------------------------------------------------------------------- |
| `properties.order_id` > `properties.orderId` > `properties.id` > `properties.cart_id` > `properties.cartId` > `properties.OrderId` > `properties.transactionID` > `properties.messageId` > `messageId` | `OrderId`                   | An order ID wins over a cart ID. Falls back to the constant `IR_AN_64_TS` if none is present. |
| `event`                                                                                                                                                                                                | `EventTypeCode`             | The first comma is removed                                                                    |
| Configured **Event Type ID**                                                                                                                                                                           | `EventTypeId`               | Sent as a number                                                                              |
| `Amount` / `amount` > `properties.total` > `properties.revenue` > the order total Chord works out from `properties.value`, `properties.price` or the products                                          | `Amount`                    | Only sent when no line items are present                                                      |
| `properties.revenue` > `properties.total` > the computed order total                                                                                                                                   | `OrderSubTotalPostDiscount` | Only sent when the first product has no price (or there are no products)                      |
| `OrderPromoCode` / `orderPromoCode` > `properties.coupon` > first product's `coupon`                                                                                                                   | `OrderPromoCode`            |                                                                                               |
| `CurrencyCode` / `currencyCode` > `properties.currency`                                                                                                                                                | `CurrencyCode`              | Not sent if absent. There is no default.                                                      |
| `OrderDiscount` / `orderDiscount` > `properties.discount`                                                                                                                                              | `OrderDiscount`             |                                                                                               |
| `OrderShipping` / `orderShipping` > `properties.shipping`                                                                                                                                              | `OrderShipping`             |                                                                                               |
| `OrderTax` / `orderTax` > `properties.tax`                                                                                                                                                             | `OrderTax`                  |                                                                                               |
| `context.traits.status` > `properties.repeat` mapped to `"EXISTING"` (true) / `"NEW"` (anything else) > `properties.CustomerStatus` / `properties.customerStatus`                                      | `CustomerStatus`            |                                                                                               |
| `CustomerCity` / `customerCity` > `properties.shipping_city`                                                                                                                                           | `CustomerCity`              |                                                                                               |
| `CustomerCountry` / `customerCountry` > `properties.shipping_country`                                                                                                                                  | `CustomerCountry`           |                                                                                               |
| `CustomerRegion` / `customerRegion` > `properties.shipping_state`                                                                                                                                      | `CustomerRegion`            |                                                                                               |
| `CustomerPostCode` / `customerPostCode` > `properties.shipping_zipcode`                                                                                                                                | `CustomerPostCode`          |                                                                                               |

**Product line items**

Each product in `properties.products[]` is submitted with a number added to the end of each field name, starting at `0`. A product with none of `product_id`, `id`, `sku` or `variant` is left out.

| Chord source (priority order)    | Impact field              | Notes                    |
| -------------------------------- | ------------------------- | ------------------------ |
| `properties.products[].sku`      | `ItemSku0`, `ItemSku1`, … | `product_id` is not used |
| `properties.products[].name`     | `ItemName0`, …            |                          |
| `properties.products[].price`    | `ItemPrice0`, …           |                          |
| `properties.products[].quantity` | `ItemQuantity0`, …        | Defaults to `1`          |
| `properties.products[].category` | `ItemCategory0`, …        |                          |
| `properties.products[].brand`    | `ItemBrand0`, …           |                          |
| `properties.products[].coupon`   | `ItemPromoCode0`, …       |                          |

Custom product mappings set in **Custom Product Field Mapping** are numbered the same way, for example `ItemColor0`.

## Custom events

This destination does not send other track events as conversions. A track event is a conversion only if its name is `Order Complete`, `Order Completed` or in the first **Event Name** list. Other track events can go to Impact as page loads. See [Event mapping](#event-mapping).

## Click ID attribution

Impact uses a `ClickId` to credit conversions to affiliate partners. Chord checks these sources in priority order:

1. **URL query parameters:** checks `PageUrl` and `context.page.search` for `irclickid`, `clickid` or `im_ref`.
2. **Client IDs:** checks `context.clientIds.irclickid`, then `context.clientIds.im_ref`, then `context.clientIds.impact`.
3. **Referrer:** checks `context.referrer.id` when `context.referrer.type` is `"impactradius"`.
4. **Properties:** checks `properties.ClickId` / `properties.clickId`.

If no click ID is found, the conversion relies on other attribution keys (`CustomProfileId`, `CustomerId`, `OrderPromoCode`) for matching.

## Testing and validation

After you connect the destination:

1. Trigger a test order from your storefront, or use the **Live Events** tab in Chord.
2. In Impact, open your program's conversion report and check that the event appears.
3. Check the **Live Events** diagnostics in Chord for API errors or credential issues.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.chord.co/activate/event-streaming/destinations/attribution-and-affiliate/impact/impact-server.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
