API Integrations for Post Interaction Surveys

Joeli Katz
Joeli Katz
  • Updated

The first step to launching a Zencity Post Interaction Survey is integrating your case record management system (CRM, CAD/RMS, or any other organizational system) with Zencity’s survey platform. We'll work with your team to determine whether an API integration is feasible. APIs (Application Programming Interfaces) enable data to be sent and received between the Zencity survey platform and your CRM software, automating the survey distribution and data collection process. 

At a minimum, we should be able to pull a unique identification/record number for each case, the date each case was solved, and contact information for each case (SMS texts being the preferred method of survey distribution, with email as an alternative). 

Below, find out what the API integration process looks like with our most commonly integrated vendors.

Note: If you use Zencity Organic, the integration can double as an organic data source and we can display the cases as items on your organic dashboard! 

 

Commonly Integrated Vendors

 

SeeClickFix by CivicPlus

You must be licensed through SeeClickFix for the private organizational API (SeeClickFix API v2 for Organizations). If you are licensed for this API, simply create an internal user account for us in your SeeClickFix organization and provide us with the user email and password.

  • If you need to use a Zencity email address for this, please use the email address of your  Zencity Customer Success Manager and inform them so that they can set a password.

 

CivicPlus

  1. Create an admin user for us in your internal CivicPlus  account and provide us with the user email and password.
  •  If you need to use a Zencity email address for this, please use the email address of your  Zencity Customer Success Manager and inform them so that they can set a password.

  1. Provide us with the API Key and Partition. If you don’t have this information, we can request it from CivicPlus support after you add us to your account. 
     
  2. Let us know whether residents submit service requests through the Citizen Request Tracker module or the Form Center module.  

    a. If requests go through the Citizen Request Tracker module, we have all we need and we’ll take the rest from there!

    b. If requests go through the Form Center module, please provide us with a list of the Form IDs that you would like us to integrate (these will be integers).

 

PublicStuff by Accela

Send an email to support@accela.com to request an API key (token) with permissions for private/internal data. Provide the key (token) to us when you receive it and we'll take it from there. 

 

Qscend by Catalis

Email the vendor at either support@qscend.com or munisupport@catalisgov.com. Inform them that Zencity is going to submit a request for an API key and that you approve this request. We'll handle the rest!

 

Granicus (fka CitySourced)

  1. We will provide you a signed partner agreement.
  2. Email the signed partner agreement to support@citysourced.com and CC us (support@zencity.io). We'll take it from there. 

 

Other Integrations

If the vendor you use is not listed above, we might still have experience working with them. We'll let you know what we need from you. In general, to begin the API integration process, we will ask for the following information. 

  1. The name of the system or vendor you use for citizen service requests
  2. The documentation for the API, if available (specifically, we need an endpoint URL that will return a list of service requests/cases, and we need to know how to structure our API calls)
  3. Authentication information, if required (many APIs require specific keys/tokens, or a username and password of an internal user to authenticate)

 

Was this article helpful?

/

Comments

0 comments

Article is closed for comments.