NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Fomo connects to a Nagent workspace with an API key. Once it is connected, agents can call 9 Fomo actions, such as "Create Fomo Event", "Create Fomo Template" and "Get Fomo Event". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Fomo, with input parameters and output schema.
FOMO_CREATE_FOMO_EVENTTool to create a new social proof event in Fomo. Use when you want to display an animated notification on your website showing recent customer activity. Events are created based on notification templates (event_type_id) and can include customer details, location, and product information.
Input parameters
URL to redirect on the event click. Maximum 255 characters.
City where the event happened. Maximum 255 characters.
Title of the event, such as a product name or action description. This will be displayed prominently in the notification.
Country where the event happened. Use ISO-2 standard country codes (e.g., US for United States). Maximum 255 characters.
Province (state) where the event happened. Use standard abbreviations (e.g., CA for California).
URL of the image to be displayed in the notification. Recommended size: 125x125px square.
First name of the person on the event. This will be displayed in the notification.
Person's IP address. When provided, Fomo will automatically extract city, province, and country parameters from it.
Optional identifier, useful for preventing duplicate events. If provided, events with the same external_id will not be created again.
Person's email address, used to create dynamic customer avatars (Gravatar). Never shown publicly.
Event type unique ID (Template ID). This is required to specify which notification template to use.
Array of custom event fields to add additional data to the event notification.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
FOMO_CREATE_FOMO_TEMPLATETool to create a Template (Event Type) in Fomo. Use when building 3rd party Fomo integrations. Templates define the message structure for notification events and can include markdown formatting, custom images, avatar support, and IP-based location mapping.
Input parameters
Friendly name for user identification of the template
Message template with variable placeholders (e.g., {{first_name}} just purchased {{item_name}})
Optional fallback image URL (must link to a hosted image, ideally < 50kb)
If set to true, an email_address parameter must be present in Event creation API call
If set to true, an ip_address parameter must be present in Event creation API call
Switch to enable markdown-flavored syntax for bold, italics, line breaks, etc. Default: false
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
FOMO_DELETE_FOMO_EVENTTool to delete a Fomo event by ID. Permanently removes the notification event from the application. Use when you need to remove a specific event from your Fomo account.
Input parameters
Event unique ID to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
FOMO_GET_FOMO_EVENTTool to retrieve a single event by ID from Fomo. Use when you need to fetch details of a specific notification event using its unique identifier.
Input parameters
Event unique id to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
FOMO_GET_STATISTICSTool to fetch notification impressions, clicks, and conversion data for your Fomo application. Returns analytics statistics within a specified date range. Use when you need to analyze notification performance metrics.
Input parameters
End date for statistics range in YYYY-MM-DD format (e.g., 2026-02-14)
Start date for statistics range in YYYY-MM-DD format (e.g., 2026-01-15)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
FOMO_LIST_EVENTSTool to retrieve all notification events from your Fomo application. Use when you need to list, query, or paginate through events. Supports pagination, sorting, and optional metadata about total event counts.
Input parameters
Page number to retrieve. Default: 1
Fields available for ordering events.
Number of events to return per page. Default: 100
Returns pagination metadata (total_count, total_pages, page, per_page) in meta attribute when enabled
Order direction for sorting events.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
FOMO_SEARCH_EVENTTool to search for a specific Fomo event by external_id or email_address. Use when you need to find a single event using a unique identifier. Returns the full event details if found.
Input parameters
Value to match by, e.g., john@gmail.com if field is email_address, or a unique ID if field is external_id
Single attribute by which to search for an event (email_address or external_id)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
FOMO_UPDATE_APPLICATIONTool to update Fomo application settings including display configuration, notification behavior, theme, position, and UTM tracking parameters. Use when you need to modify widget appearance, timing, or tracking settings for a Fomo application.
Input parameters
Application unique ID
Application URL (0-255 characters)
Application name (0-255 characters)
Widget theme options.
Whether the widget can be closed by users. Default: false
Language of application using ISO-2 standard (e.g., 'en', 'es', 'fr'). Default: 'en'
Widget position options.
Whether the application was installed. Deprecated field, will be removed in future versions.
Delay (in seconds) before the widget is displayed on page load. Default: 1
Whether to display notifications in random order. Default: false
UTM medium parameter for tracking (e.g., Google Analytics). Default: 'notification'
UTM source parameter for tracking (e.g., Google Analytics). Default: 'fomo'
Delay (in seconds) between display of notifications. Default: 1
Whether to hide the widget on mobile devices. Default: false
Time period units for display and time ago settings.
Time period units for display and time ago settings.
Duration (in seconds) each notification is displayed. Default: 1
Maximum number of notifications returned in one API call. Default: '30'
Multiplier for display_period to define time limit for displaying notifications. Formula: display_threshold * display_period. Default: 5
Whether to loop notifications continuously or display them only once. Default: true
Multiplier for time_ago_period to define time limit for displaying notifications. Formula: time_ago_threshold * time_ago_period. Default: 1
Array of event type configurations for the application
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
FOMO_UPDATE_EVENTTool to update an existing Fomo event. Changes key-value pairs of an event such as location, name, title, or custom fields. Use when you need to modify event properties after creation.
Input parameters
The unique identifier of the event to update
URL to redirect visitor to after clicking the event
City where the event happened. Maximum 255 characters.
Title of the event. Maximum 255 characters.
Country where the event happened (ISO-2 standard). Maximum 255 characters.
Province where the event happened. Maximum 255 characters.
URL of the image to be displayed. Maximum 255 characters.
Time should be in UTC and use '2018-01-01 23:00:00Z' formatting
First name of the person on the event
Person's IP address, used to extract city, province, and country parameters
Optional identifier, useful for preventing duplicates
Person's email address, used to create dynamic customer avatars. Never shown publicly.
Event type unique ID. This is the template ID used for the event notification.
Array of custom event fields to add to the event
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 9 Fomo actions on Nagent, including "Create Fomo Event", "Create Fomo Template" and "Get Fomo Event". Create Fomo Event: Create a new social proof event in Fomo. Each action is listed on this page with its input parameters and its output.
Fomo connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Fomo Event takes 1 required input: event_type_id. It also takes 11 optional inputs: url, city, title, country, province, image_url, first_name, ip_address, external_id, email_address and custom_event_fields_attributes. It returns data, error and successful.