Insites Docs Instance NotificationsAPI Call Notifications

API Call Notifications

Last updated on August 01, 2024.

An API call refers to a request made by one software program to another program over the internet. An API (Application Programming Interface) defines a set of protocols, rules, and tools for building software applications, allowing different programs to communicate with each other even if they are built using different programming languages or run on different platforms.

When a program needs to access some data or perform a specific task that is available in another program, it can make an API call to request that data or task. For example, You can create API calls and API endpoints that allow your Instance to to execute a particular action (such as automatically send an SMS or email notification to the site Administrators) when a new user registers on your website.

You may use the properties listed in the table below to configure your API call notifications:

Property Default Field Type Description
N/A Endpoint for the API call. Accepts Liquid code.
The number of minutes the notification should be delayed. You can use Liquid to calculate the number. For example, you can easily schedule an email to be sent the next day at 10 am time:
Boolean Defines whether an alert should be invoked. If false, it will be ignored.
Liquid condition to control whether notification should be sent. The only value that allows notification to be delivered is true. If you skip it, the notification will be sent (unless is false). On notification, the is checked after the delay has been executed.

Liquid code which should evaluate to a valid request type:

If you want to send binary files:
Reference

You can learn more about API Calls and API Call Notifications thru the following documentation:

Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.