Final URL

The RelayState parameter includes a Flow URL that will direct them to the correct page in the Flow environment once authentication is complete, which comprises of a Base URL and Querystring Parameters.

The final URL will take on the structure of: {{Base URL}}&{{querystring parameters}}

Base URL

Depending on the template logic used, the Base URL will be either one of the following below:

Template Route Logic
Base URL - Staging
Base URL - Production

Querystring Parameters

The following parameters will be part of the string:

Querystring parameter
Description

templateID

Pre-agreed template ID, or a user-selected template that is stored on the integration partner’s system

campaignGoalType

  • “FlowFuel” for listing campaigns

  • “FlowBrand” for brand awareness campaigns for agents

propertyExternalId

Property ID of the property to be used in the advert. If this is a FlowFuel campaign, provide the property reference from your system that has been passed to Flow in the listing feed

agentExternalId

The integration partners' identifier that would be referenced in the syndication of property listings

callbackURL

URL for returning to the integration partners’ environment once the advert is published successfully (this must already be URL Encoded)

Last updated