How to create an App with ION

Whether you need to create a custom integration or create an automation, this will serve as your main guide for getting started

Getting Access to ION

If you don't already, you will need access to ION to build an App for it. There are a few options for you.

• If you are building an integration for your organization, ask your admin to grant you access to your organization's ION sandbox.

• If you are building an integration for an external organization, you will need to ask the external organization to grant you access. See Organization settings for more details on how to get access to another organization's environment.

Please keep in mind Gov Cloud is restricted to US persons only. If you are a non-US person building an App for a Gov Cloud-compliant organization, we recommend using your ION sandbox and giving access to other domains as seen above.

If a sandbox has not been created for your organization yet, please reach out to First Resonance. This request will be processed in a week.

Permissions

Once you are in ION, you will need to be given access to various parts of the platform in order to develop what you need. An admin or a user with the right permissions will need to grant you access to those parts of the platform. See Role based access control for those details and to help understand what aspects of ION you may need access to depending on the integration. Two places you will need permissions for is API Keys and Webhooks.

The permissions at the time of API Key creation are the permissions the integration will have. See API Keys for more details.

Connection

You will need Access Tokens to work with ION's API. The associated guide will explain how to use them to create your integration flows. Once you have tested out access tokens, we recommend using our Webhooks guide to create and test webhooks to understand their payload and how they can trigger your integration.

Once you are completely familiar with our API and Webhooks, we suggest developing the app in an iPaaS tool such as Boomi, Prismatic, or Informatica. These platforms will use version control, increase the development speed with their low code capabilities, and test the application before rolling it out to Production. However, you can choose a traditional programming environment (Python, Node.js, etc.).

Flow Diagram

As you determine the details of the app, we recommend creating a flow diagram that lists the triggers, the steps, and the API calls you need to ensure you have the right permissions before getting started.

As a rule of thumb, every unique mutation in ION has an associated permission with it. See Interactive API explorer for more details. For event drive triggers, see Webhooks.

In many cases, you will need to configure new attributes in ION as needed to represent all of the data for the integration flow. These are covered in the Attributes section.

Testing

Create a UAT document to ensure all of the edge cases are either manually tested or tested through a test suite automatically. Once you have covered all of the edge cases in your UAT, roll this out to production by creating a new instance of the app in the organization's production environment. You will need a new set of API keys and webhooks for the production environment.