Flow Documentation
Back to Flow Platform
  • Back to Flow Platform
  • Getting Started
  • Publisher Documentation
    • Introduction
    • Integrating with Flow
      • The Integration Journey
      • How to choose your integration method
        • Set-up requirements for the different integration methods
      • Integrating via Console, Link-Out and Smartfeed
        • Console
          • Console Set-Up Steps
          • Flow Console Authentication
            • Authentication method: SAML Single Sign-On
              • Final URL
        • Link-Out (self-serve)
          • Link-Out Road Map
          • Choosing between Link-Out Advanced or Basic
          • Link-Out Set-Up Steps
          • Link-Out Authentication
          • Link-Out Advanced: For clients with a feed configured
          • Link-Out Basic: Alternative to a Content Feed
        • Smartfeed
          • Smartfeed Set-up Steps
          • How the Smartfeed Engine Works
          • Campaign Triggers
      • Content Feeds
        • Content Feed Overview: What is it, why we use it, do you need it
        • Setting up a Content Feed
        • Listing API
      • Campaign Packages
        • Campaign Packages Overview: What is it, why we use it, do you need it
        • Structuring a Package
        • Understanding Campaign Objectives
      • Webhooks
        • Campaigns Webhooks
        • Leads Webhooks
      • Analytics API
        • Campaigns
        • Insights
    • Account Configuration
      • Navigating the Flow Console
      • Channel Configuration
      • Audience Tracking
      • Custom Ad Templates
      • Whitelabelling
    • Managing the Flow Console
      • Navigating the Flow Console
      • Campaigns
        • Publishing Campaigns
        • Monitoring Campaigns
        • Managing Subscriptions
      • Analytics
        • Flow Insights Dashboard: Enterprise Organisation
        • Flow Enterprise Dashboard: Filtering your Data
        • Flow Enterprise Dashboard: Insights Available
      • Content
        • Editing Content Manually
        • Add Content Manually
        • Previewing Content
        • Viewing Your Brands
      • Enquiries
      • Packages
        • How to create Campaign Packages
        • How to edit a Campaign Package
      • Brand Library
        • Editing Brand Assets
        • Ad Templates
      • General - Flow Settings
        • Reset Your Password
        • Wallet
        • Linking Your Social Media Pages
        • Adding Your Meta Pixel
        • Settings
          • General Section: Organisation, Enquiries, Colors, Address, Partners Settings
          • Users Section: Managing user profiles
          • Channel Configuration Section: Managing linked channels
          • Developer Section: Feed logs, manage Campaign Settings
    • Data Publisher Integration
      • Data Collection Methods
      • Uploading Hashed Files
  • Advertiser Documentation
    • Introduction
    • Navigating the Flow Console
    • Campaigns
      • Publishing Campaigns
      • Monitoring Campaigns
      • Managing Subscriptions
    • Analytics
      • Analytics Dashboards
    • Enquiries
    • General - Flow Settings
      • Reset Your Password
      • Wallet
      • Linking Your Social Media Pages
      • Profile - Your Own Information
  • Changelog
Powered by GitBook
On this page
  1. Publisher Documentation
  2. Integrating with Flow
  3. Integrating via Console, Link-Out and Smartfeed
  4. Console
  5. Flow Console Authentication
  6. Authentication method: SAML Single Sign-On

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

Organisation provides a template function or pre-selects templates

Use Flow’s template gallery

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 6 months ago

https://app-staging.flowliving.com/campaigns/add
https://app.flowliving.com/campaigns/add
https://app-staging.flowliving.com/campaigns/template
https://app.flowliving.com/campaigns/template