Link-Out Advanced: For clients with a feed configured

In addition to requiring a feed, the Link-Out Advanced integration now supports passing multiple listings within a single JWT payload. This enhancement allows for dynamic ad creation, enabling campaigns to be associated with multiple listings at once.

For over-arching information on integrating a traditional Content Feed, go here.

It will be necessary for the organisation to create a service to generate the unique JWT token that confirms to industry standard RFC 7519, with the following structure:

// Header - Specify the token type and signing algorithm:
{
  "typ": "JWT",
  "alg": "HS256"
}

// Payload example (parameter definitions below)
{
  "route": "/campaigns/plan/ref",
  "planRef": "fuel-recur-carousel-001",
  "agentExternalId": "2076",
  "listingExternalId": "RNR5103,RNR2240",
  "organisationId": "217",
  "iss": "63e38413d61b79399110de79",
  "exp": 1766486138,
  "iat": 1700826706
}

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 Routes below 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
agentExternalId	Unique agent identifier that corresponds to the agent for the product
listingExternalId	Unique product reference for the content that will be created and promoted. This is comma separated and can support multiple products in order to create dynamic ads.
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

Route value	Action
/campaigns/plan/ref	Campaign creation with a pre-selected Flow plan, referenced by a unique plan reference
/campaigns/plan/gallery	Campaign creation without a pre-selected Flow plan, prompting the user to select a plan as the first step in the campaign creation process

Note, that there are new Link-Out routes for campaign creations without a Listing Feed. More information on this is found here.

Each JWT must be signed using the pre-shared secretKey that will be provided to the enterprise partner.

These keys will be shared with the partner once the listing feed has successfully run and all agencies/branches/offices have been created, and will be used by Flow to verify the JWT once received, before allowing the user to proceed to the Flow platform. The partner must ensure they store the secretKey securely on their platform