Introduction

Welcome to the ClickFix documentation!

We offer several types of features to help you customize your Ontraport Pages, streamline your workflows, and integrate with other applications.

Our features are divided into several categories:

• Shortcodes : customize your Ontraport Pages and transform fields into powerful inputs
• Magic Hooks : use webhooks to simplify complex processes (we aim to add requests within 72 hours; request here)
• Ontra-App Toolkit : use data from Custom Objects on the front end, and build internal systems via internal Ontra-Apps or powerful external Ontra-Apps to serve clients
• Integrations : Connect with external applications
• Payments : flexible payment solutions with multiple methods, currencies, and cart options
• Other features and plugins

This documentation includes detailed information about each of these features and how to use them. On the right side, you will find examples, demos, case studies, and templates that you can use.

There are different types of ClickFix accounts, and some features are only available for certain types of accounts. Here's what the symbols mean:

🆓 : These features are available for Free Account and above

➰ : These features are only available for Essential Account and above

💡 : These features are only available for Marketer Account and above

♾️ : These features are only available for Pro Account

You can upgrade your account anytime by clicking here.

This documentation is a work in progress, so if you have any suggestions for how to make it better, please let us know in the Facebook Group. Thank you for using ClickFix!

Getting Started

How to use this documentation

Register your Domain Names

If you want to use our Shortcode on your pages, you need to register your domain name with us.

To do this, go to https://app.clickfix.io/managedomains/ while beeing logged into ClickFix.

Keep in mind that each ClickFix Plan has a limit on the number of domains you can register. If you want to register more domains, you can upgrade your account in your account settings.

Enter Your Ontraport Keys

(If you are on a Free Account you may skip this part)

If you want to use our special ClickFix Shortcodes on your pages, you need to give us your Ontraport API keys. To do this, click on this link while you are logged in to ClickFix: https://app.clickfix.io/manageontraportkeys/

Remember, if you have the Basic Plan, you can only use one set of Ontraport API keys at a time. But if you want to use more, you can go to your account settings and upgrade your account.

Get Help

If you have a question that you can't find the answer to, or you see a mistake in this documentation, you can get help by logging into https://app.clickfix.io and going to the Help Center.
You can also post about it in the Facebook Group and someone will try to help you.

Shortcodes 🆓/➰/💡/♾️

Shortcodes are used as you would use Javascript code.

You can use them within the headers of your Ontraport Pages (or more generally in most places where you can add Javascript), or anywhere else you want on the page (links, titles, text...).

To use Shortcodes on your Ontraport Pages, you have to add a special line of code called an "import script" to the header of your page. Here's what it looks like:

<script src="https://klikfx.com/js/1"></script>

You also have to make sure the website you want to use the Shortcodes on is listed here:

https://app.clickfix.io/managedomains/

Even though Shortcodes were originally made for Ontraport Pages, you can use them on other types of websites too as long as you can insert the <script src="https://klikfx.com/js/1"></script> import script.

Pro Tip :
If you don't want people visiting your website to see the Shortcodes, you can use an invisible <div> to hide them. It looks like this:

<script src="https://klikfx.com/js/1"></script>
<div style="display:none;">
%Add Your Shortcodes Here%
</div>

Note on Dynamic Blocks
Sometimes, Shortcodes don't work well with "Dynamic Blocks".

But now, if you add [loop: before any Shortcode, it will work properly.

So for example instead of this :
[StarRating max=5 rating=[Block//Rating]]

You would do this :

[loop:StarRating max=5 rating=[Block//Rating]]

Conditions 🆓/➰/💡/♾️

Conditions shortcodes allow you to perform actions based on a specific condition being met.
They are similar to campaign triggers, which also allow you to execute actions based on specific conditions.

They consist of an opening [If] shortcode and a closing [/If] shortcode.

[IfAnchor]

Simple :

[IfAnchor #%trigger.anchor%]
%[do_something]%
%keyword%
[/IfAnchor]

Advanced :

[IfAnchor #%trigger.$variable%]
%[do_something]%
$%variable%
[/IfAnchor]

This shortcode will Trigger one or more Actions - %[do_something]% - and/or display a String - %keyword%- when a certain link #%trigger.anchor% is Triggered.

You can also use it with WildCards with the help of the $ sign (see Examples and Demos for more information on this Feature).

An Anchor can be Triggered :

• by a user clicking on a link
• by using other special shortcodes like [Redirect] or [MultiStep]

Remember :

• This Shortcode needs an Opening Shortcode, [IfAnchor], and a Closing Shortcode, [/IfAnchor]
• You can put this Shortcode all on one line like this:
  
  [IfAnchor][do_something][/IfAnchor]
  
  or on multiple lines like this:
  
  [IfAnchor]
  [do_something]
  [/IfAnchor]
  
  
• If you send someone to a page and the link has an Anchor, it will Trigger when the page is loaded
• It is usually better not to use [IfAnchor] with a #%block_id% as your #%trigger.anchor% because the page may moove before %[do_something]% is finished, which can cause the page to act strange if the block was hidden at first. In this case, we would use a [Redirect #%block_id%] just before the closing [/IfAnchor]

[IfBump]

[IfBump %bump_id% %is/not% checked]
%[do_something]%
%keyword%
[/IfBump]

This shortcode will Trigger one or more Actions - %[do_something]% - and/or display a String - %keyword%- based on whether your %bump_id% is checked or not.

Remember :

• This Shortcode is "Always-On", which means that if you want to show a block when a bump is checked, it will stay hidden until the bump is actually checked
• This Shortcode requires an Opening Shortcode, [IfBump, and a Closing Shortcode, [/IfBump]
• You can put this Shortcode all on one line like this:
  
  [IfBump][do_something][/IfBump]
  
  or on multiple lines like this:
  
  [IfBump]
[do_something]
[/IfBump]
  
  

[IfUrl]

Contains :

[IfUrl type=contains %parameter%]
%[do_something]%
%keyword%
[/IfUrl]

Parameter is :

[IfUrl type=query %url_parameter% %operator% %target_value%]
%[do_something]%
%keyword%
[/IfUrl]

Unlike IfField, which will execute the reverse shortcode if not true, IfUrl will not do that. This means you will need to first use a hide to hide all conditional elements for example, and then use IfUrl to display the one you want displayed.

[IfField]

[IfField %target_field% %operator% %target_value_01%,%target_value_02%]
%[do_something]%
%keyword%
[/IfField]

This shortcode will Trigger one or more Actions - %[do_something]% - and/or display a String - %keyword%- based on whether your %target_field% and your %target_value% match according to your %operator%.

You can use this Shortcode for simple or complex comparisons. See the examples for more information.

Remember :

• This Shortcode is "Always-On", which means that if you want to show a block when a field has a certain value, it will stay hidden until the field actually has that value
• This Shortcode requires an Opening Shortcode, [IfField], and a Closing Shortcode, [/IfField]
• You can put this Shortcode all on one line like this:
  
  [IfField][do_something][/IfField]
  
  or on multiple lines like this:
  
  [IfField]
[do_something]
[/IfField]
  
  

[IfVar]

[IfVar %$var% %operator% %target_value_01%,%target_value_02%]
%[do_something]%
%keyword%
[/IfVar]

This shortcode will Trigger one or more Actions - %[do_something]% - and/or display a String - %keyword%- based on whether your %$var% and your %target_value% match according to your %operator%.

You can use this Shortcode for simple or complex comparisons. See the examples for more information.

Remember :

• This Shortcode is "Always-On", which means that if you want to show a block when a variable has a certain value, it will stay hidden until the variable actually has that value
• This Shortcode requires an Opening Shortcode, [IfVar], and a Closing Shortcode, [/IfVar]
• You can put this Shortcode all on one line like this:
  
  [IfVar][do_something][/IfVar]
  
  or on multiple lines like this:
  
  [IfVar]
[do_something]
[/IfVar]
  
  

Graphic Helpers 🆓

[ToolTip]

[ToolTip %id_of_element% in #%block_id% delay=%delay content=" content" follow-cursor=yes/no placement=top/bottom/left/right theme=light/light-border/material/translucent interactive=yes/no]

This shortcode will add a Tooltip : "content" when you hover your cursor over an element with the ID %id_of_element% the block with the ID #block_id.

[CSS]

CSS shortcodes can be used to add custom styling to the different parts of your Ontraport Pages:

Blocks
Columns
Elements
Fields*
Rows*

*NOTE: To target Fields & Rows, you’ll need an advanced understanding of how CSS selectors & the inspector panel works.

[CSS] - Targets Blocks

[CSS #%id_of_target_block_01%,#%id_of_target_block_02% “%css-property01%:%value01%;%css-property02%:%value02%;”]

The declaration block contains one or more declarations separated by semicolons ; .

Each declaration includes a CSS property name and a value, separated by a colon : .

A CSS declaration always ends with a semicolon ; , and the shortcode declaration is surrounded by square brackets [ ].

[StarRating]

Parameters

[StarRating rating=x/$%variable% max=x star-size=x]

This shortcode allows you to build a star rating system.

[PhoneStyle]

[PhoneStyle field=%target_field_1%,%target_field_2%]

This shortcode will change the way a phone field looks by adding a dropdown menu for selecting a country. The dropdown will be filled with the correct country for the visitor based on their IP address.

You can also add CSS parameters to the shortcode such as :

background-color=#The background color code

dropdown-divider-color=#The dropdown divider color code

dropdown-bg-color-hover=#The hover color code

line-height= The heigh of the line in pixel ( px )

margin-top/bottom/left/right= The heigh of the margin in each the direction you choose in pixel ( px )

[IfScreen]

[IfScreen min-width:%pixels%px and max-width:%pixels%px]
[/IfScreen]

The Screen Targeting shortcode lets you change your Ontraport pages depending on the size of the screen your visitor is using.

*NOTE: You can also use it to change the way your page looks based on the device orientation, like if it's a phone or a tablet.

These shortcodes work like Media Queries, which are usually only used for CSS.
But we modified them so you can use any shortcode or display text based on the screen size you set.

[IfScreen min-width:%number%px]
%[do_something]%
%keyword%
[/IfScreen]

This shortcode will Trigger one or more Actions - %[do_something]% and/or display a String - %keyword% for any screen that is AT LEAST %number%px wide.

Also please note that:
This shortcode requires an Opening Shortcode - [IfScreen] and a Closing Shortcode - [/IfScreen]
This shortcode DOES NOT require line-breaks

[FloatingBlock]

[FloatingBlock %block_id% left=%value_left% top=%value_top%]

This shortcode will make the block with ID #block_id stay in the same place on your screen as you scroll the page, you can also use bottom=%value_bottom% and right=%value_right%, any combination of those attributes.

Remember :
*You should only use one of top or bottom, and one of left or right.

[FloatingElement]

[FloatingElement %id_of_element% of #%block_id% onscroll=yes/no width=%value_width top=%value_top% right=%value_left%]

This shortcode will make the Element with ID %id_of_element% of #block_id stay in the same place on your screen as you scroll the page, you can also use bottom=%value_bottom% and right=%value_right%, any combination of those attributes.

Remember :
*You should only use one of top or bottom, and one of left or right.

[StickyBlock]

[StickyBlock %block_id% %top_offset%]

This shortcode will make the block sticky, it will stick to the position after scrolling to the certain position(%top_offset%).

[StickyColumn]

[StickyColumn %id_of_column% in/of %block_id% %top_offset% freeze=%freeze%]

This Shortcode will make the Column sticky, it will stick to the position after scrolling to the certain position(%top_offset%).

[StickyElement]

[StickyElement %id_of_element% in/of %block_id% %top_offset% freeze=%freeze%]

This shortcode will make the element sticky, it will stick to the position after scrolling to the certain position(%top_offset%).

[ProgressBar]

[ProgressBar x=%value_x% y=%value_y%]

This special Shortcode will show a progress bar on your page using data from different sources :

• from a regular Ontraport [Merge] field
• from a url parameter
• from a [Calc] variable on your page

X is the current score, Y is the maximum score.

Page Manipulation 🆓

Page Manipulation Shortcodes allows you to hide certain parts of your Ontraport pages (and then display them again) :

• Blocks
• Columns
• Elements
• Fields

However, you can't use it with rows because they can't be identified individually.

(There is a Feature Request with Ontraport here).

Page Manipulation Shortcodes can be :

• Used in combination with our Conditions Shortcodes.
• Combined together (But be careful, because if you hide a column that has an element in it and then try to show the element, it won't work because the surrounding column is hidden).

[HideBlock][ShowBlock]

[HideBlock #%id_of_target_block_01%,#%id_of_target_block_02%]

This shortcode can show or hide a block or a series of blocks on an Ontraport Page.

[HideDynamicBlock][ShowDynamicBlock]

[HideDynamicBlock %id_of_target_dynamicblock%]
[ShowDynamicBlock %id_of_target_dynamicblock%]

This shortcode can show or hide a Dynamic Block on an Ontraport Page.

[HideColumn][ShowColumn]

[HideColumn %id_of_column_01%,%id_of_column_02% in #%block_id%]
[ShowColumn %id_of_column_01%,%id_of_column_02% in #%block_id%]

This shortcode can show or hide a column or a series of column, within a specific block, on an Ontraport Page.

NOTE: It is usually better to use the [ShowElement]/[HideElement] Shortcodes instead, because HideColumn can sometimes mess up the formatting of the page unless if you use it on a single column row.

[HideElement][ShowElement]

[HideElement %id_of_element_01%,%id_of_element_02% in #%block_id%]
[ShowElement %id_of_element_01%,%id_of_element_02% in #%block_id%]

This Shortcode can show or hide an Element or a series of Elements, within a specific Block, on an Ontraport Page.

[HideField][ShowField]

[HideField %target_field_01%,%target_field_02%]
[ShowField %target_field_01%,%target_field_02%]

This Shortcode can show or hide a Field or a series of Fields on an Ontraport Page or an Ontraport Form.

Note that on an Ontraport Form, you'll need to add the "ontraform" parameter : [HideField %target_field_01% ontraform]

Note : be careful not to hide a required field. If a field is required AND hidden, the "required" part will break the form, meaning the form will appear to submit despite the required field, BUT Ontraport will not register the data.

[Tabs]

[Tabs #%id_of_target_block_01%,#%id_of_target_block_02%]

This Shortcode will create a system of Tabs from your Blocks automatically, meaning it will hide and show the Blocks based on the Anchor clicked.

You will then simply need to link buttons to #%id_of_target_block_01% and #%id_of_target_block_02% so your Visitors can use the Tabs feature.

By default, all the blocks that make up the tabs will be hidden. If you want a specific block to be displayed when the page loads, you can use the [HideBlock #%id_of_target_block%] Shortcode right after the [Tabs] Shortcode.

You can have as many [Tabs] as you want using this Shortcode.

Data Manipulation 🆓/➰/💡/♾️

[Calc]

Parameters

[Calc %target_field_01%,$%variable_01%=%target_field_02% +|-|*|/ $%variable_02% round=x display]

This shortcode lets you build anything from very basic calculations (adding or subtracting a number from a field when a button is clicked for example) to highly complex quote forms.

Please note that :

• You can use Text, Long Text and Dropdowns fields with this functionnality. Obviously, if you do so, calculus won't work for those Fields and Variables.
• Variables always need to start with the dollar sign ($) And the only special character you can use in a variable name is an underscore (_).
• Fields and variables that don't have a value will be considered zero.

[SetVar]

[SetVar $var="STRING"]

This shortcode allows you to define a variable, similar to [Calc $var="STRING"] except it will remove any character that Calc could interfere with such as -*/+.

[Autocomplete]

This shortcode allows you to provide a list of options for the user to choose from when filling out a form field : %target_field%.

[Autocomplete #%target_field% options='a,b,c,d']

The options can be provided as a string, with each option separated by a comma.

[Autocomplete #%target_field_01% options=#%target_field_02%]

Or the options can be provided from the contents of another field : %target_field_02%.

[ToNumber]

[ToNumber $mvyar=[Merge]]

Will turn a string into a numeric, to remove currency data when merging Price fields for example.

Can then be displayed/used as a regular variable in Calc :

[Calc $myvar display]

[EncryptBeforeSubmit]

[EncryptBeforeSubmit fields=%target_field_01%,%target_field_02% form=#%id_of_target_block% key=%public_key%]

This shortcode is used to encrypt data in fields before it is submitted to a form.

You can use this to let your Visitors submit sensitive data without it ever being sent/stored unencrypted over the Internet.

In Ontraport you will only see an Encrypted version of your visitor's Input, and you will need to use your %private_key% in order to read it in the future (see below).

Please note that :

• Encrypted content can take a lot of space compared to an Unencrypted String, so we advise you to use Long Fields
• Your RSA Keys will look similar to this :
  

-----BEGIN PUBLIC KEY-----
MFswDQYJKoZIhvcNAQEBBQADSgAwRwJAcEzl7YR3bK7A8r8JlgH3SnDhpSU532Rl
xkPPLzpUpAlq2t6r3aYqX7DKQoKPGA/yvL25efvGQj3APrhWkZZCQwIDAQAB
-----END PUBLIC KEY-----

Remember to remove the top -----BEGIN PUBLIC KEY----- and the bottom -----END PUBLIC KEY----- so you can replace %public_key% with the Key itself and only that (see examples).

• To Decrypt the content, you can use the same tool you used to generate your keys. Simply replace the Private Key with yours.
• We can automate this process for you if you tell us how you want it. Just Contact Us and let us know.

[SyncFields]

[SyncFields %target_field_01%,%target_field_02%]

This shortcode will make sure that all the fields with the same name on a page have the same value.

You can use this if you want to build a One Page Survey for example, or a One Page, Mulsti Step checkout form with multiple Form Submissions (the data is sent to Ontraport even if they don't complete every step of the Form) through our MultiStep Shortcode.

Note that you can just add [SynchFields] to your page to synchronize all the fields of all your forms, but this might slow down your page if you have too many fields or forms.

[SyncCoupon]

[SyncCoupon #fieldid,fieldname]

Will synchronize the coupon code into a field on the page.

Better Fields ➰/💡/♾️

[EmailVerification]

[EmailVerification field=xxx(default : look for email) reject=risky(level at which we stop) message='Your email is invalid' suggestion=yes/no submit=yes/no]

This Shortcode will check if an email address is valid.

Rejection level :

• reject=risky
  A risky result means the email addresses appears to exist, but have quality issues that may result in low engagement or a bounce. This includes emails such as info@, contact@ or admin@
  
  
• reject=unknown
Unknown occurs when we are unable to get a valid response from the recipient's email server. This may happen when the destination email server is too slow or temporarily unavailable.
  
  
• reject=undeliverable
  An email is considered undeliverable if the email addresse does not exist, or is syntactically incorrect.

[SearchField]

[SearchField TOKEN FilterListName field=%field_name% preview="{%field_name%} {%field_name%}" trigger=#selected.{%field_name%}]

This shortcode will let you transform a field into a searchbox of a filtered list.

[PhoneVerification]

[PhoneVerification field=xxx message='Your number is invalid' submit=no/yes background-color=#XXXXX dropdown-divider-color=#XXXXX dropdown-bg-hover=#XXXXX line-height=39px margin-top=1px margin-left=1px]

This shortcode is used to verify the validity of a phone number.

You can also add CSS parameters to the shortcode such as :

background-color=#The background color code

dropdown-divider-color=#The dropdown divider color code

dropdown-bg-hover=#The hover color code

line-height= The heigh of the line in pixel ( px )

margin-top/bottom/left/right= The heigh of the margin in each the direction you choose in pixel ( px )

[GetAddress]

[GetAddress %target_field% hide=%hide% language=%language% gkey=%google_key%]

This shortcode will let your visitors give you their physical address using just one visible search field, and prefilling the default Ontraport address fields using the searched address.

Note that if you use a Long Text type Field (such as Notes), your Browser will throw a JavaScript Error, but you can dismiss it, it'll work like a charm.

You can also map the different part of the address to fields of your choice like this :

[GetAddress %target_field%language=%language% gkey=%google_key% address=billing_address1 city=billing_city zip=billing_zip state=billing_state country=billing_country]

If you do this you will need to hide the fields manually.

Notes :

• Address 2 field is never used and should be offered to your customers so they can enter things like appartement number

How to get your Google Map Key

Step 1

Go to the Google Developer Console.

Step 2

Click on “Select Project”. If you have already created a Google Project before, one will automatically be seclected (in this capture, it’s “My Project”).

Step 3

Click on "New Project". You'll be required to enter a name.

Step 4

Once you've picked a name, you'll see a notification at the top right corner while your project is being created.

Once that's done, go back to Step 2 and select your newly created project.

Step 5

Click on “+ ENABLE APIS AND SERVICES”.

Step 6

Search for "Places API" and click "Enable". Then do the same for "Maps JavaScript API".

Step 7

After enabling the Places API, you’ll see the Places API management dashboard. Click on the “Credentials” tab.

Step 8

Click on "To view all credentials or create new credentials visit Credentials in APIs & Services".

Step 9

Click on “Create Credentials” -> “API Key”.

Step 10

Bravo, you now have your API Key which you can use in place of %google_key% in your [GetAddress] shortcodes.

Note that you have to create a billing account and add a payment method to be able to use the Places API.

To do so go to https://console.cloud.google.com/, click on “Get started for free” and fill up the needed information.

As of September 2019 this feature is being offered free of charge by Google.

You can learn more about Google's Pricing here :
https://developers.google.com/places/web-service/usage-and-billing#basic-data

[QrScan]

[QrScan #%trigger.anchor% %redirect_url%={QR}]

This shortcode will allow you to pop up a QR-Code scanner through a button linking to a #%trigger.anchor%, allowing your visitor to scan it using a webcam or phone camera.

Once a QR code is successfully scanned, the visitor will be redirected to the %redirect_url% specified in the shortcode. In the %redirect_url%, you can use the {QR} placeholder to insert the data from the scanned QR code.

You can have multiple [QrScan] shortcodes on a page, allowing you to have multiple buttons, redirect URLs, and functions.

Note that you can use Magic Hooks to turn a string into a QR-Code.

This combined with our other tools should let you build very complex QR Systems, covering most use cases from Ticketing to Inventory Management or even Order Tracking. Contact us if you need help.

[Signature]

[Signature %target_field%]

This shortcode will transform the target field into a signature drawing box, allowing users to sign with their mouse or finger if they are on a touchscreen.

The signature image will be encoded and stored as a "data://" string that can be used as an image src attribute on pages. Note that this will not work in Emails.

You can use this image by simply calling the value of the field in place of the image url in an email or an Ontraport Page.

[Scheduling]

Our Scheduling Better Field is a set of Shortcodes and Webhooks that will let you build very simple or infinitely complex Appointment Booking Setups.

[Schedule]

[Schedule %target_field% %public_scheduling_token%]

This shortcode will transform the target Date and Time Field into a Calendar Booking field, allowing your users to pick a free Date and Time on your Calendar.

This will then fill that Date and Time field with the proper Date/Time/Timezone combination, which will then be sent to Ontraport upon form submission.

Note that in order to avoid any Double Booking, you must set your "Log an event into your calendar" webhook in order for the event to be added to your calendar.

[ScheduleTimer]

[ScheduleTimer token=%public_scheduling_token% block=#%block_id% display=yes/no]

This Shortcode will set an Ontraport Countdown Timer to the next available time for the Scheduling Module related to your Token.

Log an event into your calendar

This Webhook will add an event to your calendar.

To use this Magic Hook, get your %private_scheduling_token%by visiting the link provided.
Once you have your token, you can simply POST the following Webhook from your Ontraport Campaign:

https://klikfx.com/api/schedule/log-event?token=%private_scheduling_token%

POST Parameters:

Populate Fields with "Add to Calendar" links

This Webhook allows you to populate a contact or object's fields with "click to add to calendar" links for different calendar services. Allowing you to then send an email to the person you're having an appointment with so they can simply add the event to their preferred calendar.

To use this Magic Hook, you will need to get your %private_scheduling_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/api/schedule/add-to-calendar-links?token=[%private_scheduling_token%]

POST Parameters:

The rest of parameters are used to describe the configuration of your fields and links you want to get, in following format:

f1234=google&f1235=yahoo&f1236=ics

NB: It is important to note that ICS requires a Long Text field to be used !

Supported providers are:

[UploadBox]

[UploadBox %target_field% %your_token% subfolder=%a_folder_name%]

Create Folder In Your Storage

This hook creates a folder in your UploadBox storage. To use it please obtain your %clickfix_token% and your uploadbox token. Send this webhook from your Ontraport Automation:

https://klikfx.com/a/h/storage-folder?token=[your_clickfix_token]

NB: Only supports Google Drive storages.

NB: The created directory will be shared for reading for anyone with an URL. To prevent that, use "Private Links" setting in your storage.

NB: As a safety measure set by Google we cannot interact with folders that were not created via the API, so you can’t add files or folders to an existing folders, and creating a folder with an existing name will simply create a new folder.

Edit Folder Name

This hook will modify a folder in your UploadBox storage. To use it please obtain your %clickfix_token% and your UploadBox token. Send this webhook from your Ontraport Automation:

https://klikfx.com/a/h/storage-folder-change-path?token=[your_clickfix_token]

NB: As a safety measure set by Google we cannot interact with folders that were not created via the API, so you can’t edit the name of a folder that was not created via the API.

[UploadToField]

[UploadToField %field%]

Will make an upload box that'll allow you to turn an image or any file into a date:// string to be stored inside a long text field.

Others 🆓/➰/💡/♾️

[Random]

Simple :

[Random]

This shortcode generates a random numeric number.

It can be used as a unique identifier for users in a multi-step form if you don’t require their email address as a first step for example. Simply add this shortcode as “prefill” to a hidden field, and use a [SyncFields] shortcode to propagate that randomly generated identifier across your different forms.

It's important to note that using this shortcode requires you to add the fields to your page and hide them using the clickfix Hide shortcodes.

[FillField]

[FillField %target_field% with "%keyword%"]

Will Fill the Field %target_field% with %keyword%.

[FillField %target_field%with url %url_parameter_01%,%url_parameter_02%]

Will Fill the Field %target_field% with the value of your %url_parameter_01%, and if not found of your %url_parameter_02%.

[FillField %target_field%with url %url_parameter_01%,%url_parameter_02% or "%keyword%"]

Will Fill the Field %target_field% with the value of your %url_parameter_01%, and if not found of your %url_parameter_02%, and if not found it will Fill it with %keyword%.

[FillField %target_checkbox_field%with %checked/unchecked%]

Will set your %target_checkbox_field% as either %checked% or %unchecked%.

[BumpQuantity]

[BumpQuantity quantity=%quantity%]

Will update the quantity of a product in a Bump.

You will need to active "Allow the buyer to change quantity" for the product in the bump you want to update the quantity of.

A %quantity%can a numeric or a $var.

[ThisBlock]

[ThisBlock $var]

This shortcode will allow you to grab the ID of the surrounding block and store it into a $variable.

To be used as [loop:ThisBlock $var[Block//ID]] to be able to act on individual blocks generated via Dynamic Blocks.

[CopyFields]

[CopyFields %field_name_1%,%field_name_X% of #%source_block_id% to #%target_block_id%]

This Shortcode will copy all the selected field from one block to the targeted block.

[FillBump]

[FillBump %bump_id% in #%id_block% with %checked/unchecked%]

Will set your bump: %bump_id% in the block: #%id_block% as either %checked% or %unchecked%.

[FillCoupon]

[FillCoupon %url_parameter% in #%id_of_target_block%]

Will Fill and Submit the Coupon Field in the #%id_of_target_block% Block with the value of your %url_parameter%.

[FillCoupon "%coupon%" in #%id_of_target_block]

Will Fill and Submit the Coupon Field in the #%id_of_target_block% Block with %coupon%.

If no Block ID is provided we will fill the first coupon field we find.

[FillFrame]

[FillFrame #%frame_id% %url_parameter_01%,%url_parameter_02%]

It is not possible for a Frame (in our case, an Ontraport Form embedded in a Page) to access parameters from the URL.

This shortcode will let you send those parameters manually to the Frame so you can exploit it (for prefilling Fields for example.

Note that when using Frames you must add the ClickFix import script ( <script src="https://klikfx.com/js/1"></script>) to both the Page Header and a Custom HTML Block at the Ontraport Form level.

[FillFrame #%frame_id% anchor=#%trigger.anchor%]

This shortcode will let you send those parameters manually to the Frame so you can exploit it with [IfAnchor #%trigger.anchor%] %[do_something]%[/IfAnchor].

[FromURL]

[FromURL %url_parameter_01%,%url_parameter_02% or "%keyword%"]

Mostly Deprecated : On your Ontraport Pages you can now just do [%url_parameter%] to get the same functionality. This Shortcode - as most of our Shortcodes - can be used outside of Ontraport Pages though.

This Shortcode will display the Value found in the Browser URL for %url_parameter_01%. If not found it will look for %url_parameter_02%, and if this is not found it will display your "%keyword%".

[MultiStep]

Simple :

[MultiStep #%id_of_target_block% #%trigger.anchor%]

This shortcode will :

• Prevent the automatic redirection that occurs on Ontraport after a visitor submits the form located in the block with ID #%id_of_target_block%
• Send the data from the form located in the block with ID #%id_of_target_block%to Ontraport.
• Trigger your #%trigger.anchor% when the form located in the block with ID #%id_of_target_block% is Submitted.

The Shortcode [MultiStep] can be used multiple times on a single Ontraport page, allowing for the creation of seamless multi-step experiences for visitors while still saving all data to Ontraport in case they do not reach the final step.

It's important to note that, in general, a unique identifier such as an email address from the URL is needed to identify the contact across different forms. In such cases, our [SyncFields] shortcode can be used to help with this.

It's also noteworthy that when using shipping on an order form in a second block, the address data from the first block may not be automatically populated, so it's necessary to add and hide the address fields on the second block.

Additionally, if "Merge via cookie data" checkbox is enabled in the form settings, it can help to alleviate potential issues that may arise when using multistep forms, such as blank contact creation if fields are not properly synched.

Advanced :

[MultiStep #%id_of_target_block% #%trigger.$variable%]

You can use your Variable $variable defined through your [Calc] shortcodes Trigger an Anchor.

[Redirect]

[Redirect %url%]

or

[Redirect #%anchor%]

This shortcode will Redirect a Visitor to a %url% or an #%anchor%(triggering any related [IfAnchor] in the process).

You are Required. to provide an Anchor or a URL to Redirect the Visitor to.

Other possible syntax :

[Redirect url="%url%"]

Use if you have a complex url that includes parameters.

[Redirect url="%url%?param={fromurl:%url_parameter%}" ]

Will grab a url parameter to append to the redirect url.

[SearchReplace]

[SearchReplace search="A string" replace="Another string" monitor=#%blockid%]

This shortcode will search for a specified string on the page and replace it with another specified string.

It can be useful for translating text on a page, such as in a payment form.

The shortcode includes an attribute "monitor" where you can specify the ID of the block containing the text that needs to be translated, allowing the shortcode to dynamically update the translation as the user interacts with the page.

monitor=#blockid of your payment form

Because the payment form tends to evolve / needs to be retranslated as the user interacts with the page (if they enter a coupon code for example).

[Submit]

[Submit #%id_of_target_block%]

This Shortcode will Submit the Form contained in the Block with ID #%id_of_target_block%.

If no #%id_of_target_block% is provided, this Shortcode will Submit the first form found on the page.

So for Ontraport Forms, you can simply use [Submit].

[ShowAfter]

[ShowAfter %time%]
%[do_something]%
%keyword%
[/ShowAfter]

This shortcode will Trigger one or more Actions - %[do_something]% - and/or display a String - %keyword%- after a certain %time%.

Please note that :

• This Shortcode requires an Opening Shortcode, [ShowAfter], and a Closing Shortcode, [/ShowAfter]
• You can put this Shortcode all on one line like this:
  
  [ShowAfter][do_something][/ShowAfter]
  
  or on multiple lines like this:
  
  [ShowAfter]
[do_something]
[/ShowAfter]
  
  

[TheYear]

[TheYear]

Will display the current year.

[Timer]

Step 1

[Timer type=%timer_type% field=%target_field% display=yes/no]

This Shortcode will set an Ontraport Countdown on an Ontraport Page to a date and time related to your %timer_type% and Fill the %target_field% with a TimeStamp (allowing you to transfer this TimeStamp over to Page 2, or to send it via Email to your Visitor).

Note that your %target_field% will be hidden automatically.

Your %target_field% must be either a Numeric, a Text, a Long Text Field or Date & Time Fields.

%timer_type%

%target_field%

May be #%field_id% or %field_name%. Because the same Field will have the same name if it is on the page multiple times, you may target a specific Field by targeting its #%field_id%.

If you use %field_name% and multiple Fields with the same name are found on the page, all fields will be Filled.

You can save yourself some time by using our Free Chrome Plugin to find your Field's ID or Name.

%display%

Step 2

[Timer param=%url_parameter% submit=#%id_of_target_block%]

This Shortcode will collect the TimeStamp from your %url_parameter% and submit the Form with ID #%id_of_target_block% once the Timer has expired.

[Today]

[Today %format%(optional) var=%$a_variable_name%]

[UpdateQuantity]

[UpdateQuantity id=%quantity field id% quantity=%quantity%]

Will update the quantity of a specific product.

You can get the %quantity field id% using our Chrome Plugin. Simply highlight Fields IDs and click on the quantity you want to update to Copy the id to your clipboard.

A %quantity%can a numeric or a $var.

[Validate]

[Validate %target_field% %validation_type% "%validation_message%"]

This shortcode will prevent a Form Submission if the %validation_type% deems the content of the %target_field% non-valid and will display your custom %validation_message% in place of the Ontraport one.

Magic Hooks ➰/💡/♾️

Magic Hooks provides a set of endpoints that allows you to simplify complex processes by performing multiple tasks through a single webhook.

If you require a Magic Hook that is not currently available, you can request it on the ClickFix Facebook Group and we will add it in!

URL Shortener

The URL Shortener allows you to create short, unique, and customized links to send to your clients instead of using PURLs.

To use this feature, you will need to obtain your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/api/misc/short-url?

The Hook and all the Parameters above go into the "destination URL" box. The URL you want to shorten goes into the "data to send" box.

Helpers

Get any Object's Data into fields

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/map-to-custom?

Document To Field

The Document To Field Magic Hook will read a doc, docx or pdf document and will send its content to a field.

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/doc2field?

Linkedin Parser

The Linkedin Parser Magic Hook will read a linkedin profile page and will extract its content to a field.

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/linkedin-scrapper?token=%clickfix_token%

Format Magic Hook

To use this Magic Hook, get your %clickfix_token%. Please note that your token must have a "Format value" permission enabled. Then POST this WebHook from your Ontraport Campaign:

https://klikfx.com/a/h/format?token=%clickfix_token%

Format webhook supports any currency and decimal/thousand separators supported by Ontraport.

Valid types

Email Verification Magic Hook

To use this Magic Hook, get your %clickfix_token%. Please note that your token must have a "Phone and Email Verification" permission enabled. Then POST this WebHook from your Ontraport Campaign:

https://klikfx.com/api/misc/check-email?token=%clickfix_token%

Data map

The payload you provide can contain a map of object fields and response fields. Said map, if passed, will update your destination object with response data.

Available response fields:

For example, if you wish to populate your object with domain, result and reason, simply add the following:

f1234=domain&f1235=result&f1236=reason

Data map: result values

Data map: reason values

Phone Verification Webhook

To use this Magic Hook, get your %clickfix_token%. Please note that your token must have a "Phone and Email Verification" permission enabled. Then POST this WebHook from your Ontraport Campaign:

https://klikfx.com/api/misc/check-phone?token=%clickfix_token%

Data map

The payload you provide can contain a map of object fields and response fields. Said map, if passed, will update your destination object with response data.

Available response fields:

For example, if you wish to populate your object with carrier, line type and "Can be internationally dialled" trait, simply add the following:

f1234=carrier&f1235=line_type&f1236=can_be_internationally_dialled

Gather Affiliate & Sub-Affiliate Data

This Magic Hook allows you to retrieve and populate data about affiliates into a specific field of a Contact or Object record in your Ontraport account.

To use this hook, you will need to first get your %clickfix_token% and then POST this WebHooks from your Ontraport Campaign.

https://klikfx.com/api/misc/affiliate-report?

It's important to note that the conditions[id]=[Contact ID] is always required.

This webhook will calculate some data about affiliates and put it into your destination object. For example, you can get a number and sum of sales into a specific fields of your partners contact and use it in your marketing campaigns or reports.
Additionally, you can specify multiple values to calculate in the totals variable. For example, this code: &totals[f1234]=sales&totals[f1235]=visits will put a total of sales by this affiliate in the field f1234 and a number of visits in the field f1235 of a contact record.

Available totals

Affiliate data

Sub-affiliate data

Sub-affiliates are those affiliates who had been referred by your affiliate.

Conditions

A condition for affiliate ID is required and is set in this format: &conditions[id]=[Contact ID].

A condition for product is optional. It is set in this format: &conditions[product]=[Product ID]. If set, this product condition will affect the following variables:

• product_sales
• product_sub_sales
• approved_commission_count
• approved_commission_total
• approved_commission_amount
• pending_commission_count
• pending_commission_total
• pending_commission_amount

Ontraport Page to PDF

The PDF Converter Magic Hook is a helpful tool for converting your Ontraport pages into neat PDF files and uploading them into your storage. The URL of the file will be storred in a specified field of a Contact or custom object.

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/generate-upload-pdf?token=%clickfix_token%

This Hook supports both POST and GET methods, though it's highly recommended to use POST payload, to avoid any problems with your URL encoding.

NB: Please note that conversion may take a while. Despite this period is very short, it's not recommended to create any campaign actions right after you triggered the webhook. Instead, make a trigger on field update.

Mark a task as complete

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/complete-task?

This magic hook will find a task for a specific contact or object and mark it as complete.

String -> QR Code

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/qr?

3rd Party Integrations

ClickFunnels -> Ontraport : Log Transactions

To use this Magic Hook, you will first need to get your %clickfix_token%, ensure that you have given it both ClickFunnels permissions, and then add this WebHook :

https://klikfx.com/a/h/clickfunnels-purchase/%clickfix_token%

...in the webhook section of your Funnel in ClickFunnels, which you’ll find under “Settings” when editing a Funnel.

Purchases will be logged :

• Using the exact same product name (make sure product names are identical in ClickFunnels and in Ontraport)
• Without consideration for currency (so if your Ontraport account is in USD but you sell a 50€ product on ClickFunnels, we’ll log a $50 transaction in Ontraport)

The Webhook Screen should look like this in ClickFunnels :

Twilio : Send a SMS/MMS

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/twilio-sms?

Orders

Change Open Order Partner

This MagicHook changes or removes a partner from open order.

To use this Magic Hook, get your %clickfix_token%, add the permission for this Magic Hook and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/change-partner?token=[%YOUR_CLICKFIX_TOKEN%]

Add Product To Open Order

To use this Magic Hook, get your %clickfix_token%, add the permission for this Magic Hook and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/add-product?

Swap Open Order Product with Another Product and Price

To use this Magic Hook, get your %clickfix_token%, add the permission for this Magic Hook and simply POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/swap-subscription?

Note that if two open orders are found containing the same product we will only change the last created.

Change Default Credit Card to Last Card Added

This magic hook will look for the last card added by a Contact and set it as default credit card.

To use this Magic Hook, get your %clickfix_token% and then send a POST payload to this address:
https://klikfx.com/a/h/change-default-card?

Required parameters

Change next charge date on an open order

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/change-charge-date?

Log Transaction

This magic hook serves to log or charge a transaction into your account.

To use this Magic Hook, get your %clickfix_token% and then send a GET or POST payload to this address:
https://klikfx.com/a/h/log-transaction

Required parameters

Transaction Parameters:
Enhanced transaction data. All parameters are optional except gateway (which is required under certain conditions).

Contact Parameters
You can pass some contact data together with transaction data. All parameters are optional. Note that those parameters will replace the data you already have.

Product configuration

Product configuration comes in standard HTTP query array. The keys of this array are product identifiers (either ID or name), and values may depend of desired purchase type.

The simpliest configuration you can provide is products[10]=25, which means it's one-time purchase of product with ID=10, for $25. To adjust your sale in a little bit more sophisticated way, you must provide options in following format:

products[ID or Name][Option Name]=Option Value

Available options are:

The following options are available if type is subscription or payment_plan.

None of product options are required; though one has to provide at least one to get the product into a transaction. Product options can be multiple and provided as joined by ampersand (&).

Example:
Let's say we want to sell a treadmill for $1200 and a subscription to a great newsletter about physical exercises for $10 per month.
We want to include two products: one with ID = 2 and one named Treadmill. First product is subscription, which costs $10 per month. Second one is one-time purchase. Thus, we're sending products this way:

products[2][price]=$10.00&products[2][type]=subscription&products[Treadmill]=1200

Send Recurring Invoices (or not)

To use this Magic Hook, get your %clickfix_token% and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/recurring-invoice?

Update Next Charge Amount On An Open Order

To use this Magic Hook, get your %clickfix_token%, add the permission for this Magic Hook and then POST this WebHook from your Ontraport Campaign :

https://klikfx.com/a/h/update-order?

Note that if two open orders are found containing the same product we will only change the last created.

Update transaction status

This magic hook serves to update a transaction in your account.

To use this Magic Hook, get your %clickfix_token% and then send a GET payload to this address:
https://klikfx.com/a/h/update-transaction-status

Required parameters

Transaction Query:
Those parameters are to find your transaction in OAP.
NB: Only ONE parameter of the following should present in your request.

Reporting ♾️

Report

This Magic Hook provides a possibility to retrieve a short report of objects and optionally put them into a destination object record.

To use this Magic Hook, get your %clickfix_token% and then send a GET payload to this address:
https://klikfx.com/a/h/report?token=[Your Magic Hooks Token]

Parameters

Report Conditions

You can define several conditions for your report. They come in a standard query array format:

conditions[firstname]=Anna&conditions[country]=US

Also, there are several special formats for conditions.

• Condition Preset: report engine supports several presets for conditions. To use a preset, just pass its name like a regular condition value: conditions[fieldname]=PresetName. For example, conditions[date]=LastMonth. Supported presets are:

  • ThisWeek - a date range between Monday 0:00 and today.
  • ThisMonth - a date range between this month 1st 0:00 and today.
  • ThisYear - a date range between Jan 1st 0:00 and today.
  • LastWeek - last week, from Monday 0:00 to Sunday, 23:59.
  • LastMonth - last month, from 1st 0:00 to last day of last month, 23:59.
  • LastYear - last year, from Jan 1st 0:00 to Dec, 31, 23:59.
  • Last30Days - last 30 days.
  • Last7Days - last 7 days.

• Date condition: you can define a date condition by setting up a base date and an optional interval to add to it or substract from it.

  • Base date can be set up as now or in dd-mm-yyyy format. Please note that this format is compatible with Ontraport European Dash date format.
    Each part of base date (either day, month, or year part) can be replaced with zeroes. Zeroes mean current day/month/year, i.e. 01-01-0000 will be interpreted as January 1st of the current year.
  • Interval (which we add to or substract from base date) can be set up as one or several amount-unit pairs in this fashion: <+/-><offset><unit:day,week,month,year>. This way, now-2week defines a day 2 weeks ago, and 01-01-2019+1year1day is for Jan 02, 2020.

  Single date condition always means 1 day, from 00:00:00 to 23:59:59. To set up a date range wider than 1 day, see Range below.

• Range: to define a range, you have to set up begin and end of range in this fashion:
  conditions[f1234][begin]=10&conditions[f1234][end]=50. This will return all records where f1234 is between 10 and 50.
  You can also set only one value for the range: conditions[f1234][end]=50. This will return all records where f1234 is below 50.

• Date Range
  Each border of range can be a date. To set it up, see Date condition.
  If you set up a date range, please note that both first and last days are included in a range.
  For example, conditions[f1234][begin]=01-01-0000&conditions[f1234][end]=31-03-0000 defines a first quarter of current year.

• List:
  To define a generic list, simply pass all the list values separated by comma. This way, conditions[f1234]=0,50 will return records with f1234=0 or f1234=50.

• Empty values:
  There are several empty values supported by report engine:

Please note that it's necessary to pick a correct empty value for a certain field type. Text fields, when not containing any value, can be either NULL or empty string.

Lists also support NULL and empty values. Thus, the safest way to check if a text field is empty is &conditions[f1234]=,NULL (note the comma). This means that f1234 will be checked against empty string or NULL value.

All other values which do not fit the formats above, will be considered as ordinary values. I.e., conditions[firstname]=Anna will return records where "firstname" field is Anna.

Passing empty conditions or not passing them at all will get all objects in count.

Report Totals

All total fields except quantity (qty) must also be defined in Ontraport object administration as totals. When you define custom object numeric field in Field Editor, you can see that Ontraport allows you to pick one of the options:

• Show total at the top
• Show average at the top
• Show nothing.

Picking "Show total at the top" or "Show average at the top" will result in defining field as total. Thus, this magic hook will be available to return the totals of this field.

Besides that, you can always get a number of objects which meet your criteria. To do that, pass a keyword qty as field name: totals[]=qty&totals[]=f1234.

Using multiple destination fields

It could happen that one needs to update several fields with totals by several columns in one request. Instead of repeating the webhook to fill all destination fields, one can use special syntax for declaring desired totals: totals[Destination Field 1 ID]=qty&totals[Destination Field 2 ID]

Example:
Let's say destination object has fields like (f1234) "Quantity" and (f1235) "Total sum". We want to fill them respectively with source object amount and total by column f1236. Thus, totals must be set in this fashion:

totals[f1234]=qty&totals[f1235]=f1236

Using totals without setting destination fields, like totals[]=qty&totals[]=f1234, will lead to {qty:1,f1234:1200} value in destObjectField field.

Using multiple destination fields together with destObjectField is deprecated.

Report Destination object

This magic hook also supports putting report results into mutable Ontraport object (usually it's Contacts and custom objects). Format of resulting field value depends on totals parameter. For example, we have 20 objects that meet the condition, and sum of f1234 field values of these objects is 2500. If there's only one defined total, destination object will contain only its value, i.e. totals[]=f1234 will cause destination object field contain 2500.

If you pass several totals like totals[]=qty&totals[]=f1234, destination object field will contain standard JSON-encoded object: {"f1234":2500,"qty":20}.

Tag Count

This Magic Hook calculates a number of objects having a specific tag.

To use this Magic Hook, get your %clickfix_token% and then send a GET payload to this address:
https://klikfx.com/a/h/tag-count?token=[Your Magic Hooks Token]

Parameters

Integrations ➰/💡/♾️

Ontraport -> ProfitWell ➰/💡/♾️

To learn more about how to use ProfitWell, which provides free subscription metrics to help identify opportunities, reduce churn, optimize pricing, and grow your subscription business, visit their website at https://www.profitwell.com/

Our integration will synchronize your past open orders and payment plans, up to the current date, to give you an accurate churn rate and Monthly Recurring Revenue (MRR).

For more information on setting up this feature, check out this tutorial : https://youtu.be/UfKCQsrN6w8

Where to find my key

Shopify -> Ontraport ➰/💡/♾️

This integration will :

1. Send every transaction from your Shopify Store into your Ontraport account
2. Create a product if not found by name
3. Create a tax if not found by name
4. Send all customer data into Ontraport (cellphones go into sms_number and other types of phone will go into Office Phone)
5. Tag the contact Shopify_ClickFix

To start the synchronization :

Step 1 : Add your Ontraport API keys here if not done yet : link

Step 2 : Grab your Shopify Token

2.a Hit Settings (bottom left) => Apps and sales channels => Develop app => Allow => Allow

2.b Create an app => Enter any name => Configure admin api scope => Search for “read_orders” and check it => Hit save

2.c API Credential => Install app => Instal => Reveal Token Once => Copy your token

Then go to http://app.clickfix.io/shopify

and Past it into a new clickfix module

Select your ontraport key, and that’s it! You are now synchronized

ChatGPT -> Ontraport ➰/💡/♾️

This document outlines the steps required to integrate ChatGPT with OpenAI API to enable users to send queries and receive responses in a specific objectid/id combo.

New magic hook route :

https://klikfx.com/a/h/chatgpt?

NB: If there is an error with the ChatGPT response it will fill your &field= with chatgpt_returned_error, so you can use this on automation!

Completion Models we support listed by strength. Those models only require a simple prompt as query:

Chat Models we support listed by strength. Those models require you to build a prompt using this format :

[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Who won the world series in 2020?"},
{"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."},
{"role": "user", "content": "Where was it played?"}
]

CrowdRise -> Ontraport ♾️

This integration will allow you to seamlessly synchronize your CrowdRise data with your Ontraport account, giving you access to all of Ontraport's powerful features and functionality.

Setting up the integration can be complex and will require the assistance of a ClickFix agent. Fortunately, this service is provided free of charge.

To learn more and get started, please Contact us.

Manage Inventory ➰/💡/♾️

Here is how it works :
Video Explanation

#1 : Create a new contact owner field in Ontraport's field editor here.
#2 Create a module in ClickFix and select the newly created field as the target field.
#3 Grab the [Merge] shortcode provided in the inventory module.

And voila, you now can :

• update the contact owner field when someone purchases a product
• use the ifvar shortcode to show/hide your order form based on inventory left

Payments ♾️

Stripe SEPA Payments

MUST READ

Using this feature means you will be dealing with bank accounts number. 

So you must use the same field on this page and in the actual form you use to collect IBAN number.

This way, we will replace the clear IBAN with a secret code called “Stripe Source”.

This is given to us by Stripe that will allow us to charge your client’s account.

Also, it saves you from having to store IBAN numbers for any length of time.

Step 1 : Generate a Stripe Secret Key

1. Log into your Stripe account and click this link : https://dashboard.stripe.com/account/apikeys/create

2. Set the permissions as follow :
   
   Charges : Read & Write
   Customers : Read & Write
   Sources : Read & Write

3. Click "Create Key"

4. Now that your key is created you can go here :
   

And click on "reveal live key token" to get your Stripe Secret Key

Step 2 : Start a new SEPA payment from an IBAN

Make sure you have a created a SEPA Payment Module here to get your Token : https://app.clickfix.io/stripesepa/

https://klikfx.com/a/s/charge-sepa?token=%your token%&&id=[Contact ID]&invoice=[Last Invoice #]&iban=[IBAN_MERGE_FIELD]

This webhook will do a few things :

1. It will create a Stripe “Source” from the IBAN (note that if the Source creation fails, meaning the IBAN is not valid, your contact will be tagged with your Failure Tag)
2. It will charge the bank account based on invoice amount
3. It will update that invoice to “Voided”

Step 3 : Add the Stripe Webhook

In order to let Stripe know if your transactions go through you must :

1. Log into Stripe and go to this link : https://dashboard.stripe.com/account/webhooks

2. Click “Add endpoint”

3. Copy this url in the “URL to be called” field :

https://klikfx.com/a/s/capture-charge?token=%your token%

4. Select “Select types to send” and check both “charge.failed” and “charge.succeeded”
5. Click “Add endpoint”, that’s it, you’re done

Step 4 : Create a Source

You can simply create a Stripe “Source” by sending a webhook to this url :

https://klikfx.com/a/s//iban-source?token=%your token%&id=[Contact ID]&iban=[IBAN_MERGE_FIELD]

Step 5 : Charge a source

Once the IBAN has been erased and a Stripe Source has been created you can then simply charge a bank account doing this :

https://klikfx.com/a/s/charge-sepa?token=%your token%&id=[Contact ID]&invoice=[Last Invoice #]

Stripe ACH Payments

MUST READ

Using this feature means you will be dealing with bank accounts number. Please make sure whatever you do is done in accordance with the laws of your place of business.

This feature will allow you to take ACH payments from your customers in place of credit card. It is a four step process for your customers :

1. They will get to a regular Ontraport payment form, except on this page you will be using the Dummy Gateway, and the credit card information will be pre-filled with the test card and hidden, ensuring that a transaction is created in Ontraport every time this form is submitted. On this page you will ask for their account and routing number
2. Once you have their account information and a transaction, you will be sending those two to us via a webhook. In return we will create a chargeable Source in Stripe, add a Stripe source token in an Ontraport field, and Stripe will send your customers two micro payments before they can actually charge that account
3. Your customer will go to another page and confirm the two micro payments amounts. If the amounts are correct, we will update a field in the contact to confirm.
4. From there on, the initial transaction will get charged against the account, and you will be able to charge that customer using the Stripe Source token now stored in the Ontraport contact

Step 1 : Generate a Stripe Secret Key

1. Log into your Stripe account and click this link : https://dashboard.stripe.com/account/apikeys/create

2. Set the permissions as follow :
   
   Charges : Read & Write
   Customers : Read & Write
   Sources : Read & Write

3. Click "Create Key"

4. Now that your key is created you can go here :
   

And click on "reveal live key token" to get your Stripe Secret Key

Step 2 : Start a new ACH payment instance

Make sure you have a created an ACH Payment Module here to get your Token : https://app.clickfix.io/stripeach/. It is highly recommended to create a separate dummy gateway for each of the instances you start.

Step 3 : Add the Stripe Webhooks

In order to let Stripe know if your transactions go through you must :

1. Log into Stripe and go to this link : https://dashboard.stripe.com/account/webhooks

2. Click “Add endpoint”

3. Copy this url in the “URL to be called” field :

https://klikfx.com/a/su/%your token%/capture-charge

4. Select “Select types to send” and check all the following:
   • invoice.payment_succeeded
   • invoice.payment_failed
   • charge.succeeded
   • charge.failed
5. Click “Add endpoint”.
6. Add another webhook the same way:

   https://klikfx.com/a/su/%your token%/capture-verification
   

   Check all the following:
   • customer.source.updated
   • source.failed
   • source.chargeable
   • source.canceled

Step 4 : Create an ACH Campaign

Each time you want to charge a customer via ACH, you have to call a webhook:

https://klikfx.com/a/su/%your token%/entry?contact_id=[Contact ID]&last_invoice_id=[Last Invoice #]&source=[Source String (see below)]

This webhook will do a few things :

1. It will create a Stripe “Source” from the account number and routing number if this is the first transaction
2. It will create a Stripe "Customer" in your Stripe Dashboard
3. If client source isn't verified yet, it will create a Stripe invoice and put it on hold until your customers bank account will be verified and ready to charge. The transaction in Ontraport will be set to Write Off or Void while we confirm the charge went through
4. If client source isn't verified yet, it will update your Payment Source Field with Stripe codes and set your Verification Status Field to a "Pending verification".

After this, Stripe will send two micropayments to your customer's account, and you must invite them verify their account. Collect the verification data (2 integer numbers) and send it to the next webhook:

https://klikfx.com/a/su/%your-token%/verify?cid=[Contact ID]&verification[n1]=[ACH Microdeposit 1]&verification[n2]=[ACH Microdeposit 2]

This webhook will send verification data to the Stripe and verify the customer's bank account.

Source String

One can know if contacts source is verified by checking on their verification status (it should say "Verified"). This means that this contact has authorised you to withdraw money from their account.

On their first purchase, contacts bank account will not be verified, and in this case source string should consist of their account number and routing number, separated by a colon:

https://klikfx.com/a/su/%your token%/entry?contact_id=[Contact ID]&last_invoice_id=[Last Invoice #]&source=[account_number]:[routing_number]

Once they verified their bank account, there's no need to keep this data anymore. At this point a contact should have a Stripe Pair in the Payment Source Field (i.e Stripe customer ID and Stripe Source ID, separated by a colon). This information should be sent for next purchases:

https://klikfx.com/a/su/%your token%/entry?contact_id=[Contact ID]&last_invoice_id=[Last Invoice #]&source=[Payment Source Field]

Now, if everything is set up right, your customer will receive an invoice to pay. Once paid or failed, the transaction will convert to a Paid / Declined respectively.

ClickFix Apps ➰/💡/♾️

ClickFix Apps allow you to display on a page (Ontraport Page or any page where you can insert JavaScript really) data from any Ontraport Object, along with data from a set of Children Objects.

Understanding this feature

The advanced feature we offer is known as our "App Builder" and it requires some understanding of Custom Objects in Ontraport.

If you're not familiar with this concept, we recommend checking out our app building guide at https://eg.clickfix.io/appbuilder.

To give you an example of how to use this feature, let's say you want to allow a contact to view their tickets for different events.

Here's a summary of the steps you'll need to take:

• Step 0 : Make sure you're on a PRO ClickFix account, your domain name is registered with us and we have your API keys.
  
  
  
• Step 1 : Create a custom field in Ontraport to store a secret ClickFix Token, this field will be used as the ClickFix Unique ID (a text field is fine, unique or not is up to you, just don't make it required). In our example, this field would be in the Contact Object.
  
  
  
• Step 2 : Create a new Token Module in ClickFix https://app.clickfix.io/clickfixapps/, selecting Contacts and your newly created field
  
  
  
• Step 3 : Generate a ClickFix Unique ID for this individual contact through the webhook found below under "Generating a Token".
  
  
  
• Step 4 : Create a One-to-Many Relationship in Ontraport to tie the contact to their tickets, and create a loop in ClickFix around that relationship. To do this, go to the View/Edit of your newly created Token Module, and go to "Manage Relation Lists" ("Filtered Lists" are used to display data that is NOT tied through a relationship, such as a list of events or a client list)
  
  
  
• Step 5 : And that's it! Now, by using the newly created ClickFix Unique ID, you can display contact data and their different tickets anywhere you want. Repeat this process for each object / relationship.

The Ontraport part is really quite simple with one required webhook to Generate a ClickFixUID, and most of your time will be spent working on your Ontraport Pages.

The best way to learn how to use this feature is to check out our demos at https://demo.clickfix.io/, find one that matches what you're trying to build and examine the source code to see how it was done and you can simply copy paste that.

And as always, in case of doubt, contact Support!

• Note : In this specific case, if you wanted to display specific data about a ticket on a different page you would either add this data to the URL from the previous page, or add a ClickFix UID to your tickets so you can get to the data this way

ClickFix Apps Webhooks