Link-Out Basic: Alternative to a Content Feed

In the case of Link-Out Basic integration, it is possible to publish campaigns without the use of said content feed. In order to still add the appropriate content to the ad, use is made of a larger JWT payload now including basic listing information, building on the JWT in the Link-Out Advanced section. This is most applicable for ad-types that are simpler, such as single image ads.

Additional information is required to be added to the payload in order to populate the ad. In these cases, the agent representing the listing, and the listing will be pre-created before the Ad Builder interface is loaded, using the provided information in the JWT.

The JWT payload should now include the additional fields, noted below:

// Payload example (parameter definitions below)
{
  "iss": "65e5a57fb2d5280011f59ee2",
  "route": "/campaigns/plan/ref",
  "planRef": "GOLD-7Day",
  "organisationId": "0",
  "autoCreate" : "true",
  "agentExternalId": "AGENT-002",
  "agentEmail": "[email protected]",
  "agentFirstName": "Jane",
  "agentLastName": "Doe",
  "type": "property",
  "propertyExternalId": "RXBO-1884",
  "externalRef": "Order-391",
  "price": "$2,500,000 NEG",
  "location": "Melrose",
  "lat": "-26.1425373",
  "long": "28.046419",
  "title": "4 Bedroom House for Sale in Melrose",
  "shortDesc": "4 Bedroom House For Sale in Melrose. Embracing the key elements of Nordic design, this home successfully blends simplicity of design with comfort.",
  "longDesc": "4 Bedroom House For Sale in Melrose. Embracing the key elements of Nordic design, this home successfully blends simplicity of design with comfort. Upon entering you are welcomed by a formal entrance hall, and stunning open plan reception areas, which included lounge dining room and family room...",
  "url": "https://portal.flowliving.com/listings/residential/for-sale/melrose/johannesburg/gauteng/647f0f83e7abaa2709455a6e",
  "imgUrl": "https://s3.flowliving.com/public/1920x1080/647f0f83e7abaa2709455a6e_cover_Exterior1_1131212369522494.jpg"
}

Payload Parameter definitions:

Payload parameter	Description
iss	This is the same as the pre-agreed client ID that will identify the integration partner
route	Pre-defined route based on required action, see New Routes above for further information
planRef	Pre-agreed plan reference that represents the Flowplan that will be used to publish the campaign Required with /campaigns/plan/ref route
organisationId	Organisation / branch ID, “0” if no organisation structure utilised
autoCreate	Important: (true/false) Set to “true” in cases where you are uncertain if the agent or product exists in Flow, and you wish to create a new agent or listing if not. If this is not set to “true” and the agent or listing is not found, the Flow system will display an error to the user, and they will not be able to continue with the Ad Builder process
agentExternalId	Unique agent identifier that corresponds to the agent for the product
agentEmail	Unique agent email address
agentFirstName	Agent first name
agentLastName	Agent last name
type	ENUM value representing the product content type, selected from: property vehicles products recruitment retail general
propertyExternalId	Unique product reference for the content that will be created and promoted
externalRef	Optional: External reference from the enterprise partner that is unique to this campaign, e.g. order ID. This reference will be passed back to the client in the campaign webhook
price	Advertised price, including any currency units and localisation preferences
location (optional)	Text representation of the location, usually mapped to neighbourhood / suburb and used in the ad template design
lat (optional)	Listing latitude, to be used in the targeting of the ad
long (optional)	Listing longitude, to be used in the targeting of the ad
title	Short title that will be included in the ad template
shortDesc	Short description of the listing, maximum 50 character length
longDesc	Long description of the listing, maximum 300 character length
url	Listing URL, that will be used for when a user views the ad and is redirected to the listing landing page
imgUrl	Image URL for an image of the listing, to be included in the ad template design. NB: Please ensure this URL is publicly accessible