Demo to preview the settings
Introduction
This plugin retrieves the current user IP address without requiring any API key. It also provides a lot of useful information about the user based on his IP such as address coordinates, timezone.
How to set up
Adding the plugin
Add the plugin to your app, and place the IP Detector Complete element on the page.
Once added to your page, the plugin will resolve the data and IP address of the user automatically on page load and expose its data in the element states.
Here's how you can retrieve data :
The plugin is now ready to work without any additional setup.
Note that there's a delay between the page load and the moment where the IP address and the data will be ready (500ms but can be up to 1500ms). If you wish to retrieve the data only when ready, you can create your workflow under the "IP Address resolved" workflow trigger.
Element properties
Automatically detect IP Address
If checked, the plugin will automatically detect and resolve the required address and data and expose it as a state. If you want to trigger the detection manually instead, uncheck this box, this is useful to avoid to add a useless script to your page.
Events
Name | Description |
ready | IP Address is ready |
Element actions
Name | Description |
Trigger | Manually trigger the retrieval of the current IP address and data |
Get an IP | Manually trigger the retrieval of a specific IP address and data |
Trigger
If you wish to avoid the plugin to run every time the page load to save performances, you can also trigger it manually.
For that, uncheck the box "☑️ Automatically detect IP Address" in the plugin element property editor.
Then, you will need to trigger the element through a workflow when you wish to retrieve the IP address or data:
The plugin will now resolve the data and address and expose them in the element states.
Note that there's a delay between the trigger and the moment where the IP address and the data will be ready (500ms but can be up to 1500ms). If you wish to retrieve the data only when ready, you can create your workflow under the "IP Address resolved" workflow trigger.
Get an IP
You can also use the plugin to retrieve data (such as address, country, timezone,…) for a defined/custom IP address through a workflow
You will need to trigger the element through a workflow when you wish to retrieve the custom IP data:
Finally, configure the field to tell the plugin which IP you want to retrieve. This field can be formatted as IPv4 or IPv6.
The plugin will now resolve the data and address and expose them in the element states.
If the element states are not empty, they will be overridden.
Note that there's a delay between the trigger and the moment where the IP address and the data will be ready (500ms but can be up to 1500ms). If you wish to retrieve the data only when ready, you can create your workflow under the "IP Address resolved" workflow trigger.
Exposed states
Name | Type | Description |
IP ADDRESS | text | Shows the ip address of the current connection |
Data Internet provider | text | The internet provider of the connection |
Data Region | text | The region of the current connection |
Data ASN | number | ASN number |
Data Organization | text | The organization associated with the ip address |
Data Timezone | text | The timezone of the ip address |
Data Longitude | number | The longitude of the ip address |
Data Country Code (3) | text | The three letter country code of the ip address |
Data Area Code | text | The area code of the ip address |
Data City | text | The city of the ip address |
Data Country | text | The country of the ip address |
Data Continent Code | text | The continent of the ip address |
Data Country Code | text | The country code of the ip address |
Data Accuracy level (m) | number | The accuracy of the detection in meters |
Data Accuracy level (km) | number | The accuracy of the detection in kilometers |
Data Bubble Address | geographic address | The geographic address of the ip address |
Data Country Flag | image | The country flag of the ip address |
Data Country Emoji | text | The country emoji of the ip address |
