Features

Integration with Zapier

You can use Zapier to automate the data flow between FYI and other platforms, for example, Ignition, Dropbox, OneDrive, Google Drive, etc.

Zapier can also be used to automatically import and file documents in FYI. For example, if a client has given your practice access to their Dropbox, when the client has a new file in a specified folder you can use Zapier to import the file directly into FYI.

When sending documents to FYI from Zapier, it's recommended that documents are sent to a specific user within your practice. This ensures that someone within your practice (usually the person in charge of this process) is always monitoring documents that have been sent to FYI via Zapier. If the document can be auto-filed, the document is added to that user's Home - My Recent tab. If it cannot be auto-filed, it will go to that user's In Tray, ready for filing.

Ignition makes available the client email (Contact Email) which can be mapped in the Zap so that documents can auto-filed directly to FYI using this client email address.

You can alternatively use other attributes from what is being sent to populate the details in FYI such as a specific Client Name. This allows the document to be filed automatically for a specific client but would need you to set up a specific zap for each client. FYI will be soon including Client Code as a field so that, when Client Code is available for documents being imported from Zapier they can be auto-filed against the relevant client.

The following features are not currently available for general release with the Zapier Integration:

  • Create a client or client group in FYI synchronised to Xero Practice Manager
  • Create a Job

We will advise in the future when this function becomes available to FYI clients. 

Using the Integration with Zapier

To use this function:

  • You need to be a registered and subscribed user of Zapier.
  • To connect FYI to your Zapier account, an FYI Admin will need to first get the FYI Access Key that is used in the connection with Zapier.
  • Zaps need to be set up the Zapier for the relevant applications you want to connect to FYI.

FYI is able to provide support for adding data to FYI, but for queries or issues related to any third-party apps connected using Zapier, you should contact the support team of the company responsible for that app.

Setup Zapier app in FYI 

First, get the FYI Access Keys that will be used in your Zapier account to connect to FYI.

Note: This is a one-off step and can only be done by an FYI Admin, or a user in a User Group that has Permissions enabled for Automations.

  1. From FYI, click the Automation menu option.
  2. Go to the Apps tab.

    1982_Apps_Page_used_in_all.gif

  3. For the Zapier app, click the cog icon to edit it.

    2023_Edit_Zapier.gif

  4. In the Zapier Integration panel, click Create new secret. This will generate a new Access Key ID and Secret Key used to connect to FYI.

    303_Zapier_Request_Integration_Keys.gif

  5. The Access Key Secret will be displayed in a pop-up. Click the clipboard icon to copy the key and paste it to Zapier or a secure location, for example, a vault.
    Important: You will only be able to view the Secret key the first time this window is displayed. If the Key is required again, you will need to disconnect your integration and request a new Key before you reconnect your integration.

  6. Click Done once you have saved the Secret Key to a secure location.

  7. The Access Key ID will be displayed. Click the clipboard icon to copy and paste the information to Zapier or a secure location.

  8. Optionally, you can select the Cabinet and Categories that will be used as the AutoFile Defaults if these have not been set up for the client. If you set up the AutoFile Defaults, the document will not first go to a user's In Tray. 

    304_Zapier_Keys.gif

Connect Zapier to FYI

  1. As the FYI integration app is still in beta with Zapier, you need to connect using this link which gives you the beta invite.
  2. You will be prompted to log in to your Zapier account.
  3. When you have logged in, this displays a message that you have been invited to use FYI on Zapier.
  4. Click Accept Invite & Build a Zap.

    319_Invite_to_Zapier.gif

To set up a Zap

Note: The following instructions relate to Zapier functionality but show how Zapier is set up specifically for FYI. If you need additional help please check the Zapier help.

You need to set up any of the Zaps you want to use within your own Zapier account.

The Zap requires two steps:

Step 1 - Trigger Event
The Trigger Event determines where the document is coming from and what triggers the action (in this example, a new proposal document in Ignition).

Step 2 - Action Event
The Action Event in the Zap determines what to do when the Zap is triggered, the App to send it to (FYI) and what is created in FYI and how it is filed in FYI.

Setting up the Trigger in the Zap

How a Zap is set up will depend on which application is being connected to FYI. The following is an example of setting up a Zap for Ignition to FYI.

  1. When you create a Zap, you are prompted to choose an app and an event. In this example, Ignition is the App and Service Accepted by Client is selected as the Event (the triggers available will depend on the app that is selected).

    317b_Create_Zap_Trigger_PI.gif
  2. From the drop-down, select the account for the app (for example, the Ignition account for your practice). If needed, select Add new account and follow the Zapier prompts.

    317c_Create_Zap_Trigger_PI.gif
  3. Test the Trigger to check you are connecting and to find data.
  4. Click Continue to set up the Action.

Setting up the Action in the Zap

The Action (the Do this) in the Zap determines what to do when the Zap is triggered, where to send it and how it is filed in FYI.

  1. Zapier lists the supported apps. When prompted in the Do this .. to Choose App, search for and select "FYI".
  2. For the Choose Action Event, select "Create Web Link".
  3. Click Continue.

    320_Action_Step_FYI.gif
  4. Select the Account. The first time you will need to select Add an account from the drop-down selection.

    Paste the Access ID and Access Secret that you copied from FYI (see above). Then click Yes Continue.

    323_Access_Keys.gif

    Your FYI account will then show as selected.

    324_Account_connected.gif
  5. Click Continue.

Set up the fields to be passed through to FYI

Using the metadata from the documents being handed over to FYI, you customize where the documents are sent to and any information that is passed through to FYI such as the filing details, for example, the name of the document. Some of these are required.

The parameters that are available will depend on the app that the document is coming from. You will see a list of the metadata that is available from the app.

325_Set_up_Customize.gifWhen you click a field, this displays the fields that are available from the Trigger service (in the examples, from Practice Ignition).

Note: The field that shows in bold is the field name. Next to this is an example of what will be returned from the data. For example, in the screen below "1. Contact Name Frank Marshall", Contact Name is the field and Frank Marshall is a sample of what it will return. If you don't see examples of what a field will bring in, you can use the Find Data function in the Trigger Event of the Zap.


326_Selecting_fields.gif

Click Show All Values to show additional fields. Select the values as relevant.

In the example below, the Customize fields have been set up with Name as the "Proposal Name" and Web Link as the "Proposal URL". These are from Ignition.

Client Email is the "Contact Email", as per the Client List or the Client - Summary tab in FYI. User Email is set as the "Client Manager Email" within FYI so that when the files are imported, they are imported to that user's In Tray, ready for filing.

As well as Client Email, you can also include the fields for Client Code, Export Code, and XPM ID as the information that is sent. This will allow FYI to assign it to a specific client depending on what data is available so it can match to the client if there is no Client Email.

327_Action_fields.gif

You can add text that will be sent in addition to the contents of a field.
1104_Zapier_Field_with_text.gif

You can add more than one field (remember to add a space between them).

1106_Zapier_Field_with_text_and_two_fields.gif

In the Send Data section, you can send a test to review what you have set up.

Remember to turn the Zap "On".

Create File Note

As well as creating a Web Link to a document in Ignition, you can set up a Zap to create a File Note in FYI.

1102_Zapier_Create_File_Note.gif

The fields are the same as for Create Web Link with the addition of HTML and it does not include the URL field.

HTML is a required field and you can add a field from Ignition or FYI to add the initial text in the File Note that is created.

1103_Zapier_File_Note_Fields.gif

The following is an example of the File Note that is created in FYI by the Zap.

1105_File_Note_created_by_Zapier.gif

Connecting multiple Zapier accounts to FYI

You can connect more than one Zapier account to FYI. For example, if you have two separate Ignition accounts, one for your accounting practice and the other for the Financial planning practice. You can use the same Keys from FYI for both Ignition accounts using the steps below. FYI does not differentiate between them.

Notes for Ignition

  • Zapier will only bring in a Web Link as the shortcut to the document in Ignition, not the full document.
  • When using the Contact Email held in Ignition as a parameter in Zapier, if this is a shared email address, it will use the client that has been nominated as Include in AutoFile (refer to Setting Filing Defaults for a Client). If none of the clients with the same email address are set as Include in AutoFile, the document will not be auto-filed in FYI and it will go to the user's In Tray.
    However, if you have set up AutoFile Defaults in the Zapier App in FYI (see below) these defaults will be used to AutoFile the document. This also means the document will not first go to a user's In Tray.

Note for Dropbox

You need to set up the Zap for Dropbox to send the document extension as well as the document name.

Note for OneDrive

You need to set up the Zap for OneDrive to send the file to FYI. Your Zap must include the 'Name' of the Document and 'File' to be imported to FYI. 

Was this article helpful?
0 out of 0 found this helpful