Overview

If you feel that connecting your platform (server-site) directly to journy.io is your best option — so not through e.g. Segment — then a great way to move forward is by a back-end integration through our API connector.

The API calls itself are described in the following doc: https://developers.journy.io/#section/Backend and we have SDKs available for Node.js, PHP, Python and Ruby.

We recommend that you:

  • Call upsert user whenever a user is created, logs in to your application, updates email address or updates personal settings

  • Call upsert account whenever an account is created or account settings are updated

  • Set an account property to know in which stage the account is (e.g. Status = "Trial" or "Customer"). This will help you to configure lifecycle stages for your accounts. We don't recommend using events for this.

  • Send an event when a user is invited to an account

  • Link users to accounts

  • Use frontend tracking for tracking screen views (See JavaScript connector docs)

The API connector also allows you to read journy.io elements back — e.g. to create a custom dashboard on Stages, Health, Scores, Segments and other computed properties from journy.io.

This article describes the setup of the API connector named "Application" in the journy.io connection section.

How to connect "Application" REST API to journy.io

Go to your connections and click the 'Connect' button under the WebSite logo:

The following screen will appear:

Here's what to fill in:

  • Name: The is the unique name of your platform. This is mainly for UI and admin reasons throughout journy.io.

  • This application is allowed to:

    • Retrieve tracking snippet for websites: This is the way to connect both UI-side/front-end (see https://help.journy.io/en/articles/6489769-the-javascript-connector) and server-side/back-end integration. Yet, this is only possible when the option is switched on.

    • Read campaigns: If set, you can collect campaign information defined in journy.io.

    • Read channels: If set, you can collect channel information defined in journy.io.

    • Read contacts: If set, you can collect all user and account information, including all properties and events, encountered from all connected apps.

    • Read events: If set, you can collect event information defined in journy.io.

    • Read properties: If set, you can collect property information defined in journy.io.

    • Read segments: If set, you can collect segment information defined in journy.io.

    • track events, create and update contacts: If set, you can create and update users and accounts, their relationship as well as trigger events on users, on accounts and on unique combination of both user and account.

Upon pressing 'Create Application', you'll receive your unique API key to be used with out SDKs. Learn how on: https://developers.journy.io/#section/Backend/Authentication

Review API connector settings

Going to your Connection→Platform settings, you can choose Connection settings tab:

The 'Source' switch allows you to turn on and off the connection (without needing to delete or change API keys).

All other options are the same as when you connect, on top of being able to 'Regenerate' a new API key.

IMPORTANT: For extreme security reasons, there is no way to retrieve your API keys. You have to copy them somewhere safe when generated...or regenerate them.

Going to your Connection→Platform settings, you can choose Logs tab to see detailed logs on anything that is being sync'ed between journy.io and your platform.

Did this answer your question?