Documentation for the KNM Infusionsoft API handler.
Clone repository to the desired server location. cd into the installation directory and run npm install
Remove .sample extension from both config/configVars.json.sample and config/accounts.json.sample and replace the descriptions with valid configuration values. Addtional accounts can be added to the accounts.json file as needed.
- http POST (required) - To address must include the path
/incoming/cccontactId= Infusionsoft Merge Field Code~Contact.Id~accessKey= Access Key for KNM API Server. Must match key inconfig/configVars.jsontoLocation= Infusionsoft account name for the account where this record will be created. The value comes from a custom field that's on the master account's Referral Form. The value of the incoming account name must match one of thereferralIdarray values inconfig/accounts.jsonexactly.
- Receiving account must have a custom field created to accept the sending account's Contact ID number. This allows for simplified record updating later in the case that any information on either contact record changes.
- Record the field name for this custom field in the
config/accounts.jsonfile as the value for thecustomField1key, ensuring an underscore character (_) is added to the beginning of the field name. - Receiving account must have a tag to apply with a unique name that is loaded as the value for the
referTagNamekey inconfig/configVars.json
- http POST (required) - To address must include the path
/incoming/sm
contactId= Infusionsoft Merge Field Code for the custom field created to hold the master Contact ID number. The value should look like~Contact.[FieldName]~where FieldName matches thecustomField1key inconfig/accounts.jsonaccessKey= Access Key for KNM API Server. Must match key inconfig/configVars.jsontoStage= Signifier for which stage the record is moving to. Valid values arebooked,complete,not_interestedorin_progress.
No additional setup required.
- http POST (required) - To address must include the path
/incoming/fp
contactId= Infusionsoft Merge Field Code~Contact.Id~accessKey= Access Key for KNM API Server. Must match key inconfig/configVars.jsonfromAccount= Infusionsoft account identifier for the account where this record is coming from (i.e.op132,ag362)
No additional setup required.
- http POST (required) - To address must include the path
/incoming/tr
contactId= Infusionsoft Merge Field Code for contact.~Contact.Id~if this transaction is to trigger a goal in the this same account. If it is going back to the Master Account, use the merge field that hold that original contact ID.accessKey= Access Key for KNM API Server. Must match key inconfig/configVars.jsonintegration= Infusionsoft account identifier for the account where the goal is being triggered as specified in the goal configuration (i.e.op132,ag362).callName= The Call Name for the goal being triggered as specified in the goal configuration.
- Configured API Goal in a campaign (required)
Integration= The application identifier. This field is typically populated automatically (i.e.op132,ag362).Call Name= A text identifier (no spaces). Can be any text you want. It will be called by the triggering http POST.
- Production Monitoring through Loggly
Create Option to Trigger API Goals Through the AppEnsure Marketing Opt In Status is Set Set for New ContactCarry Notes Across with Contact InformationWeb Front End for Admin and Error Log ReviewError LoggingContact Lookup if Master ContactId Doesn't Exist