Fetch your API keys
Log into dashboard.pocketflows.com and navigate to the API Keys tab. If you don’t have credentials yet, reach out to us team@pocketflows.com! Pocketflows provides different environments for development and production, and you can toggle between them by using the “Test Mode” toggle at the top right corner of your dashboard. All API endpoints are authenticated using Basic HTTP authentication. Pass theproject_id
and secret_key
as username
and password
in Basic HTTP
authentication.
Create your first business
A Pocketflowsbusiness
usually maps to one of your SMB customers. For example,
if you’re Toasté, a vertical SaaS company for restaurants, a Pocketflows
business
object would map to one of your restaurant customers.
business_id
—save this value to use in the
subsequent steps below.
Create a customer within the business
A Pocketflowscustomer
refers to one of your customer’s customers. Continuing
the Toasté example, a diner at one of the restaurants that uses Toasté would be
a Pocketflows customer
. For this example, pass in your own email address in
your_email_address
and the business_id
from the previous step in the POST
request.
Create an embed
A Pocketflows embed is a URL that you can you can add directly inside your existing application so that your customers can create marketing without leaving your platform. To create an embed:Test Business
would be able to see! Now you can create a campaign, trigger,
customers, and more via our pre-built marketing flows! You can try sending
yourself any of the pre-built campaigns.