JSONPath: Difference between revisions

From Planfix
Jump to: navigation, search
No edit summary
No edit summary
Line 16: Line 16:


Planfix can parse emails in this format and add the necessary data into info blocks using the  [https://github.com/json-path/JsonPath JsonPath library].
Planfix can parse emails in this format and add the necessary data into info blocks using the  [https://github.com/json-path/JsonPath JsonPath library].
Note: If you use a function when parsing, make sure that you insert brackets at the end, otherwise the function will not work.
Note: If you use a function when parsing, make sure that you insert parenthesis at the end, otherwise the function will not work.
==Example==
==Example==
An email is sent to Planfix with JSON:
An email is sent to Planfix with JSON:

Revision as of 07:05, 26 November 2024

Use the dedicated online service to debug and fix parsing errors: JSONPath Online Evaluator

You can parse incoming emails or webhooks in Planfix with JSON. Emails sent to Planfix can be parsed using JSON. JavaScript Object Notation is a format for storing and exchanging information available as human-readable text.  There are two main elements in a JSON object: the key and the value.

Example:

{"city":"New York", "country":"United States"}
  • keys — city and country;
  • values — New York and United States

Planfix can parse emails in this format and add the necessary data into info blocks using the JsonPath library. Note: If you use a function when parsing, make sure that you insert parenthesis at the end, otherwise the function will not work.

Example

An email is sent to Planfix with JSON:

{ "firstName": "John", "lastName": "Smith", "address": { "streetAddress": "10 Main Street, Apartment 101", "city": "Pleasantville", "postalCode": 10101 }, "phoneNumbers": [ "812-123-1234", "916-123-4567" ]

}

 

Let's say we need the following data from the JSON:

{ "firstName": "John", "lastName": "Smith", "address": { "streetAddress": "10 Main Street, Apartment 101", "city": "Pleasantville", "postalCode": 10101 }, "phoneNumbers": [ "812-123-1234", "916-123-4567" ]

}

 

  • We would configure the following rule for processing emails:


WV75EQ.png


  • Next, we create a new client using the template, indicate which infoblocks to set from which fields, and add the contact to the task created from the email:


GUx1IE.png


  • As a result, the necessary data from the email in JSON format was transferred to Planfix:


vLjOz4.png



Go To