Skip to main content

What this is

RTB House Conversions API (CAPI) is a real-time destination: it sends on-site and conversion events out of Zeotap CDP to RTB House, one event per customer as they pass a Send to Destinations node in a journey. RTB House is a DSP platform that specialises in personalised retargeting, so the events you stream describe what a customer did on your site — viewed a category, viewed a product, changed their cart, completed an order — and RTB House targets against that behaviour. Every event is keyed on the customer’s RTB House Cookie, so cookie syncing between Zeotap CDP and RTB House has to be in place before anything will match. This page covers the real-time, journey-driven integration. To send a whole audience to RTB House instead, see RTB House, the batch destination that attaches to an audience rather than a journey and delivers RTB House Cookies to the S3 bucket RTB House provides.

Supported identifiers and actions

Select Stream events to RTB house under Choose your Action when you create the destination. The mapping screen marks RTB House Cookie ID and Event Timestamp as required. Both sit under Global Attributes. The remaining fields are grouped by event — Category Page Event Attributes, Offer Product Page Event Attributes and so on — so map only the attributes that belong to the event you are sending on that node.

Prerequisites

Address all of the following before you start the integration.
  • PKey. An advertiser’s public key is a unique string RTB House uses for authentication and authorisation. Obtain it from your RTB House representative.
  • API Tagging Hash. This is the static client tagging hash identifier associated with your RTB House account. Obtain it from your RTB House representative.
  • Cookie syncing is enabled between Zeotap CDP and RTB House. The integration keys every event on the RTB House Cookie, so without the sync there is no identifier to send. See Cookie Syncing.
  • RTB House has enabled server-to-server (S2S) requests on your account. Notify RTB House of your intent to send S2S requests so they can enable the configuration on their end.
  • Custom event names are shared with RTB House in advance. If you plan to send custom events, give RTB House the event name (key) first so they can configure it.

RTB House event names and parameters

RTB House identifies each piece of on-site behaviour by an event name of its own. The Event Type list on the destination uses the same vocabulary.

Event names

Sending events directly to RTB House

RTB House also accepts server-to-server postbacks sent straight to its own endpoint. This is RTB House’s API, not Zeotap’s: the request goes from your server to RTB House and does not pass through Zeotap CDP. Send it as an HTTPS POST, for example with curl:
Replace the macros as follows:

Create the RTB House CAPI destination

The destination is created under Integrate > Destinations, or inline from a journey’s Send to Destinations panel. Either route opens the same two-step form. For the general model behind destinations, actions and mappings, see Configure a destination.
1
Once you have applied filters or added conditions for your users in Journeys, open Send to Destinations. The panel lists the destinations already available to you — pick one of those, or click + Add New Destination to create one.
The Send to Destinations panel showing the + Add New Destination link, a search box and a grid of existing destination cards

The Send to Destinations panel, with the + Add New Destination link above the search box and a grid of existing destination cards

2
Search for RTB House and select RTB House CAPI.
3
On the Enter Destination Details step, complete the three fields and click Next:
  • Destination Name — a name that makes the destination easy to identify later.
  • PKey — the PKey obtained from your RTB House representative.
  • API Tagging Hash — the tagging hash associated with your RTB House account.
The PKey and the tagging hash are what authorise you on the RTB House platform.
Enter Destination Details form for RTB House CAPI, showing the Destination Name, PKey and API Tagging Hash fields with Back and Next buttons

The Enter Destination Details step of the RTB House CAPI destination, with the Destination Name, PKey and API Tagging Hash fields

4
On the Mapping step, select Stream events to RTB house under Choose your Action. Then, under Map the Fields, pair each Catalogue field with the RTB House destination field it feeds. Map only the attributes that correspond to the event you intend to send on this destination — see Supported identifiers and actions and Define the mapping.
Mapping step showing the Choose your Action drop-down set to Stream events to RTB house, and the Map the Fields table pairing Catalogue fields with RTB House destination fields grouped under Global Attributes, Category Page Event Attributes and Offer Product Page Event Attributes

The Mapping step, with Stream events to RTB house chosen as the action and the Map the Fields table grouped by event

5
Click Create Destination. The destination is created and made available for activation on Journeys.

Add the destination to a journey

A real-time destination does not attach to an audience. Once it exists, you link it in a Send to Destinations node inside the journey workflow.
1
On the journey canvas, click + where you want the node, then choose Send to Destinations from the Choose an action menu.
Choose an action menu on the journey canvas listing Add a Condition, Add a Delay, Create a Multi-branch Split, Create a True/False Split and Send to Destinations, with Send to Destinations highlighted

The Choose an action menu on the journey canvas with Send to Destinations selected

2
Find your RTB House CAPI destination in the list of available destinations, using the search box if the list is long.
Send to Destinations picker with the search box highlighted above a grid of available destination cards

The destination picker with the search box highlighted above the grid of available destinations

3
On the Destination Details tab, the Destination Name, PKey and API Tagging Hash are already filled in from the destination you created. Choose the Event Type for this node from the drop-down; the options include Home, Category, Offer, Listing, Basket Add and Basket Status, and the list continues below these.
Destination Details tab for the RTB House CAPI node, showing the pre-filled Destination Name, PKey and API Tagging Hash fields and the open Event Type list with Home, Category, Offer, Listing, Basket Add and Basket Status

The Destination Details tab of the RTB House CAPI node, with the Event Type list open

4
On the Destination Settings tab, choose the action and mapping you need.
5
Click Save Destination. The node shows the attached destination card with its action and mapping.
An attached RTB House CAPI destination card labelled with its mapping and the Stream events to RTB house action, above the destination picker grid and the Add Destinations button

The attached RTB House CAPI destination card showing its Stream events to RTB house mapping, above the destination picker

Verify the delivery

Once the journey is live, confirm the events are leaving Zeotap and landing at RTB House:
  1. On the journey canvas — open the execution details for the Send to Destinations node. A node that has run reports the total events entered, the successful events and the failed events. See Identify Journey Errors.
  2. For one customer — use Journey Traces to follow a single record through the node and inspect the input and output event data.
  3. With RTB House — confirm with your RTB House representative that events are arriving against your PKey. Zeotap reports what it sent; only RTB House can confirm what it accepted.

Troubleshoot delivery failures

When a journey execution fails at this node, a failure status code is recorded against the node. Journey Error Codes is the full reference; these are the ones most likely to appear on a conversions-API destination. Three causes specific to this integration may not surface as an error code at all:
  • No RTB House Cookie on the profile. Every event is keyed on this identifier, so a customer without a synced cookie has nothing to send. Confirm cookie syncing is in place — see Cookie Syncing.
  • A custom event RTB House has not configured. RTB House has to set up the event name (key) before you send it. If a custom event was never shared with them, confirm with your RTB House representative that it has been configured.
  • S2S not enabled on the account. RTB House has to enable server-to-server requests for your account before it accepts them.
For the wider journey-level checks, see Troubleshooting Workflows.

FAQ

They sit in different lanes and carry different payloads. RTB House CAPI, on this page, is a real-time destination: it attaches to a Send to Destinations node in a journey and streams one behavioural event at a time. RTB House is a batch destination: it attaches to an audience and delivers that audience’s RTB House Cookies to the S3 bucket RTB House provides. Both send data from Zeotap CDP to RTB House, and both depend on cookie syncing being enabled.
RTB House Cookie ID and Event Timestamp are marked as required on the mapping screen, so map those for every event. Beyond them, map only the fields belonging to the event type you are sending: the screen groups fields by event, so a category-page event needs Category Id and a product-page event needs Offer Product ID. Fields belonging to other events can be left unmapped.

Next steps

Last modified on November 5, 2026