Skip to main content

FV Decipher Support

All the topics, resources needed for FV Decipher.

FocusVision Knowledge Base

Integration with Zapier

1:  Overview

Decipher has integrated with Zapier to automate some processes.

Zapier lets you easily connect the web apps you use, making it easy to automate tedious tasks. - Zapier.com

For Decipher, Zapier can be used to send a data file or a "Saved Report" report to a list of emails periodically.  Let's get started.

2:  Generate an API Key for Decipher API Access

An API key is required to access the data.  This can be generated with either steps below.

2.2.1:  Generate an API Key from the Research Hub

To generate an API key, access the Research Hub and select "API Access" from the System Tools menu (click on your profile image/avatar).

Select "Create new API Key" and enter self to create a new API key for yourself.

If you already have an API key, then select "rekey" next to your email address to re-generate the existing API key you might have.

2.2.2:  Generate a Temporary API Key from the Research Hub

In the same area where you can generate an API key, there's also an option to generate a temporary key so that you can get started quickly with the API.

This API key will only persist and authenticate you while your current session is active.

api_temporarykey.png

3:  Setting up Zapier

Start by creating an account on Zapier.

As soon as you have an account with Zapier, click the link below to accept an invitation to use Decipher's REST API actions:

Link to Accept Invite & Go To Dashboard

Provide the same email address that you used to create your Zapier account.

As soon as you accepted the invitation, you can create a Zap to use a Decipher Beacon "Action" to:

  • Send Saved Report via Email
  • Send Data File via Email

api_zapier_zap_base.png

In this example, we'll use the "Send Saved Report via Email", but the steps for both actions are very similar if you decide to choose the other option.

The first step is to select "Make a Zap!" from Zapier's top menu bar:

On the next screen (shown below), you will need to select a "Trigger" that will perform an "Action".

zap_choose_trigger_action.png

In this example, we'll create a "Trigger" to do something daily.

Select the "Choose a Trigger app..." drop down menu, search for "Schedule" and select the clock icon for "SCHEDULE".

Then select the "Choose a Trigger..." drop-down menu and choose your preference.

With the "Trigger" in place, it's time to choose an "Action app".

Select the "Choose an Action app..." drop down menu and search for "Decipher Beacon".

When the "Choose an Action..." drop-down menu appears, select "Send Saved Report via Email".

After the steps above are complete, you should see the following:

zapier_ready_to_roll.png

When you're ready, press "Continue".

There's nothing to do in step 2 because the "Schedule account" doesn't require any authentication. Click "Continue".

In step 3 to "Select a Decipher Beacon account", use the drop-down menu to add your account information. This is where you'll paste the 64-character API key you generated earlier.

zapeir_enter_api_key.png

For most customers, you will enter "v2" here.  For customers on a private server, you will enter your cloud server prefix here.  

When you've added your information, use the "Test this Account" button to verify your information.

If you receive an error message (e.g. "invalid secret"), try visiting the Research Hub to rekey yourself and copy the API key again.

When you're all set and your "Account is working", click "Continue".

In step 4 is where you'll decide when to receive your emailed reports. Choose any time that is convenient for you using the "Time of Day" drop down menu. In this example, we'll choose "9am". When you're all set, click "Continue".

zapier_daily_send.png

Step 5 is where we'll add our survey-specific information. This includes:

  • Survey path (e.g. selfserve/9d3/12345)
  • Report ID (e.g. x4w4d1vvc2pz) (Learn more)
  • Subject
  • Format (e.g. pdf, excel, pptx, etc...)
  • Email Body
  • and Recipients

Fill in the information and press "Continue" when you're ready to test your Zap.

zapier_step_5.png

If everything was done correctly, testing out specifications in step 6 will result in "Success!".

Select "Test Schedule Trigger" to test your specifications. Once the dialog loads, select "Test Zap with this sample" to start the test. If everything worked out correctly, you should see the following:

If you receive an error message, review the following Response Codes to help diagnose the issue. If needed, review the steps above and double-check the information you supplied in step 5.

That's it! Provide a name for your Zap in step 7 and "Turn Zap on" to finalize your Zap.

Zapier will redirect you back to your "My Zaps" where you can see the Zap we just created is enabled and ready to send our report data each day at 9am.

zapier_zap_on.png

  • Was this article helpful?