CiviCRM Community Forums (archive)

ZAPIER SCRIPTING API
====================

 Zapier has a scripting library which enables us to maniulate the requests and responses that are exchanged between CiviCRM API and Zapier. With this functionality, responses can be parsed before Zapier does anything with them

For Example
===========

TRIGGER_KEY_catch_hook - runs when Zapier receives a static or subscription hook from CiviCRM  API. Can parse the response to format the data that enters Zapier.

an example format for that is shown below

var Zap = {
  TRIGGERKEY_catch_hook: function(bundle) {
    /*
    Argument:
      bundle.request.method: <str> # 'GET', 'POST', 'PATCH', 'PUT', 'DELETE'
      bundle.request.headers: <object>
      bundle.request.querystring: <str>
      bundle.request.content: <str>

      bundle.cleaned_request: <object> or <array> # our best guess at parsing
                                                  # and combining the request
                                                  # (including handling JSON & XML).
      bundle.auth_fields: <object>
      bundle.trigger_fields: <object> # the fields provided by the user during setup

      bundle.zap: <object> # info about the zap

    The response should be either a JSON serializable array...
      [
        <object>,
        <object>
      ]

    ...or a single object:
      <object>
    */
    return []; // or {}
  }
}


NOTE  ---> there is also possibility for subscription and unsubscription as explained here  https://zapier.com/developer/documentation/v2/scripting/

Reviewed the Documentation of Yesterday and completed the remaining tasks, these are:


-Learn the basics of using ‘poster’

-Create a new Trigger to reflect a contribution

-Create a new webhook as the data source

-Get a unique URL which will be used to send that data in the webhook

TASK FOR THE WEEK

- use Surveypal account on Zapier to see possibilities of a Zap between Surveypal and CiviCRM App on Zapier

- Create a new survey on surveypal
 
- Add Surveypal user account to Zapier

- Create a trigger between CiviCRM and Zapier

- Choose an action to create possibly with Surveypal

- Create action on surveypal to share the link of a survey so a user can answer a few questions

PIPELINE WORK

- Updating wiki page
- send link to mentor requesting to move wiki page to appropriate loc.

For this week I intend to to carry out the following tasks

• Complete Wiki Documentation
• Review Requirements for New extension
• Prepare For weekly meeting

The Requirement for the extension for the project on the integration of CiviCRM with Zapier has been illustrated in the steps below

• Create an extension called cm.mercimukwe.zapiercivicrm (or something like this)
• Create a class called Zapier (full name CRM_Zapiercivicrm_Zapier). This class deals with the basic Zapier on a generic level and can be used by our Proof of Concept for sending a Survey but potentially for any data to be send from CiviCRM to Zapier and receiving data from Zapier as far as we know now. I expect properties like hookUrl, userAuth, userAuthValue, timeOut, action  etc. It will probably contain methods like
  
                           setUpWebhook: set up for a Zapier webhook and storing the Zapier URL key in a property
                           config: for any setting stuff like the URL to use?
                           sendRequest: Sending a request to Zapier.
                           receiveRequest: Receiving data from Zapier Etc.
  
  
• Create a class called Survey (full name CRM_Zapiercivicrm_Survey) which extends class Zapier and holds the specific methods for our specific example. This class will hold additional properties for the specific action like tresholdAmount, email, surveyData etc. and will have specific methods or possibly overridden parent methods
• Use civix to generate an API: entity Zapier action Submit (and in the future but not in this step probably also an action Receive). This API should be as limited as possible and only call the relevant method of class Zapier with all the params required.
• Add a CiviRule action Send Zapier Request (or whatever name you like) which calls the API Zapier Submit.
• Add a CiviRule to check for the contribution condition and then send the Zapier Request