For the complete documentation index, see llms.txt. This page is also available as Markdown.
Pro EditionEnterprise Edition

Modify Contract Field Names & Descriptions

Customize and remap event type parameters in your template terms to make item-level data more descriptive for partners. For example, you can rename a generic parameter like text3 to "Festive Conversions" so partners immediately understand what the data represents.

Before you begin

  1. Audit all payout group and payout restriction rules that reference this event type.

  2. List every field on which those rules depend.

  3. Plan to manually re-add those fields as custom attributes in the new schema.

Access event type mapping

  1. From the top navigation bar, select [User profile] → Settings.

  2. On the right, under Tracking, select Event Types.

  3. Hover over the applicable event type and select [More]Schema.

    • Here, you will see the details related to each event-type schema. Refer to the reference table below.

Event type schema reference table
Schema item
Description

Attribute

The actual event type parameter passed through to impact.com with each conversion. E.g., CustomerId or CustomerRegion.

Display Name

The name of the event type parameter. You can customize the parameter's name.

Description

The description of the event-type parameter.

Privacy level

Controls whether this field's value is included in Event Notification Postbacks sent to partners.

  • Share with all partners: included in all partner postback payloads.

  • Share with no partners: excluded from all postback payloads.

  • Share with some partners: included only in postback payloads for selected partners. This does not affect brand-side reporting or stored data.

Example: Text10 stores Caller ID. By setting the privacy mode to Hide, the Caller ID data point will be excluded from the postback notification sent to a partner, even if the field is populated in the system.

Edit an event type parameter

  1. From the top navigation bar, select [User profile] → Settings.

  2. On the right, under Tracking, select Event Types.

  3. Hover over the applicable event type and select [More]Schema.

  4. Hover over the parameter you want to edit and select [More]Edit.

  5. Make your changes and select Save.

Add an event type parameter

  1. From the top navigation bar, select [User profile] → Settings.

  2. On the right, under Tracking, select Event Types.

  3. Hover over the applicable event type and select [More]Schema.

  4. On the Event Type Schema screen, in the upper-right corner, select Add.

  5. Complete the mapping information.

  6. Select Save.

Last updated

Was this helpful?