Connecting your flow to Flip is super simple. To get started, you will need access to The Bot Platform and the admin console for your Flip tenant. Once you're ready to go, follow the instructions below.

How it works

1) Head to your admin console in your Flip tenant

Once you’re logged into Flip, navigate to the admin console, and to the API Clients under "Access & Security"

https://{domain}/admin/people/api-clients

2) Create an API Client

From here, you will need to create a new API client. A pop up modal will appear, where you can fill in the following:

• Client ID: this can is whatever identifier you want to use. Try not to include any spaces in your client ID, eg use “companyflow” or “company_flow”, not “company flow”)
• Description: Not needed
• Role: change to ADMIN
• Legacy roles: CHAT_MESSAGE_TEMPLATING, WEBHOOK_MANAGEMENT
• Profile information: it needs both a first name and a last name - this is the name of the flow that the end user will see. Note that this can be changed any time. 

3) Click save and note down your API Client details

Once you’ve created the API client keep the next screen open, as you’ll need the client secret and client ID.

4) Connecting the flow on TBP to the API Client

Now you’ve created the API Client on Flip, in a new tab (you’ll need the client secret from flip) navigate to The Bot Platform, and hit the “Connect to flip” button.

From here you will now need to enter the API Client details

• Domain: the flip domain, e.g. flow.testing.flip-app.com
• Client ID: the API Client ID from flip
• Secret: the Client secret from flip

5) Click "connect"

If all your details are correct, your flow will connect to Flip, and you will be taken back to your flow's page in The Bot Platform. If you run into any issues, then please reach out to us. 

Adding a avatar to your flow

You can also update your flow’s avatar in it’s client API page. Simply open the client API, click edit and edit your avatar (at the bottom of the screen):