Data Structure

Before you get going and are authenticated, here is a quick snapshot of the resources in your account and their relationships. Much of this will be further described within each resource within the reference docs. This high-level view might be helpful while navigating the remaining documentation.

An account wraps around all of your created records and data, neatly containing them (tenant). This is why the root resource is always /v3/merchants.

For convenience, here are some jump-off points to the top-level items.

Essentials

If you logged into the API docs, you will already have both an Account and a Customer created. If not, you can click the login button in the top right corner, this is only for API usage convenience it does not feed the sales funnel.

Business Processes

From here, you can focus on understanding Business Processes and their underlying Business Process Actions. This is the building block of engaging with customers. Modeling customer engagement within a Business Process enables our system to render messages or web experiences to achieve the goals outlined in individual Business Process Actions.

On the left, scroll down to ACTION CATALOG for a full list of supported actions and how to configure each one.

Blueprints

Blueprints provide simplicity, continuity and structure to Business Processes. This is a critical concept because business processes can be 'anything'. The predictable structure enables wrapper concepts like Blueprint Triggers and Subscriptions to be a touch easier to understand, as the shared data model will no longer keep changing.

Loading…

1Pick a language

2Try It!