Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 2.27 KB

README.md

File metadata and controls

59 lines (41 loc) · 2.27 KB

Sales Jet External App Feature Client API

This simple script has been created to enable easy connection to the Sales Jet External App feature.

To run it add first_name, last_name and email as name attributes to the text inputs of the form.

<form id="salesjetForm">
    <input type="text" placeholder="FIRST NAME" name="first_name" />
    <input type="text" placeholder="LAST NAME" name="last_name" />
    <input type="text" placeholder="email" name="email" />
    <input type="submit" />
</form>

You then call the connectWithSalesJet function and pass the ApiKey, the name of the custom event you are trying to connect to in Sales Jet and a selector to the form you want to submit.

Make sure to call the function after the CDN script is loaded, in order to do that append a custom script tag after the script tag loading the CDN script:

<script
    src="https://salesjet-cdn.s3.amazonaws.com/submitFormToSalesJet.js"
    integrity="sha384-Vk3vL8B71TgtOZXxU+wj2b8A8neOGhwXYb4KjFPU8fYzcI7N9M0oaw3AqbPsbDqK"
    crossorigin="anonymous"
></script>
<script>
    connectWithSalesJet(API_KEY, CUSTOM_EVENT, selector, [no-alert]);
</script>

In case of success the function logs an object as follows:

// SUCCESS OBJECT
{ success: true, error: false, data: response };

In case of error the default behavior is just alerting an error has occured, you can override this by passing an optional 'no-alert' as the fourth parameter to the function if you want to customize error handling.

This is the error object logged in case of error:

//ERROR OBJECT
{ succes: false, error: err, data: {} };

GOTCHA

The usual behaviour of the form is prevented by the script so you'll have to programmatically add additional behaviour if you want the form to be also sent to a custom backend.

CDN

The Javascript file is hosted at Link. Add an integrity attribute to your script tag of 'sha384-Vk3vL8B71TgtOZXxU+wj2b8A8neOGhwXYb4KjFPU8fYzcI7N9M0oaw3AqbPsbDqK' for security reasons.

For more informations on how to create a custom event in Sales Jet, please refer to Sales Jet's Knowledge Base.

If you'd like to contact Sales Jet support just write to [email protected].

Please check example.html for a full implementation.