Skip to main content
Fomo logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: FOMO
  • Version: 20261101_00

Tools

Slug: 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

string
URL to redirect on the event click. Maximum 255 characters.
string
City where the event happened. Maximum 255 characters.
string
Title of the event, such as a product name or action description. This will be displayed prominently in the notification.
string
Country where the event happened. Use ISO-2 standard country codes (e.g., US for United States). Maximum 255 characters.
string
Province (state) where the event happened. Use standard abbreviations (e.g., CA for California).
string
URL of the image to be displayed in the notification. Recommended size: 125x125px square.
string
First name of the person on the event. This will be displayed in the notification.
string
Person’s IP address. When provided, Fomo will automatically extract city, province, and country parameters from it.
string
Optional identifier, useful for preventing duplicate events. If provided, events with the same external_id will not be created again.
string
Person’s email address, used to create dynamic customer avatars (Gravatar). Never shown publicly.
integer
required
Event type unique ID (Template ID). This is required to specify which notification template to use.
array
Array of custom event fields to add additional data to the event notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Friendly name for user identification of the template
string
required
Message template with variable placeholders (e.g., {{first_name}} just purchased {{item_name}})
string
Optional fallback image URL (must link to a hosted image, ideally < 50kb)
boolean
If set to true, an email_address parameter must be present in Event creation API call
boolean
If set to true, an ip_address parameter must be present in Event creation API call
boolean
Switch to enable markdown-flavored syntax for bold, italics, line breaks, etc. Default: false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Event unique ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Event unique id to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
End date for statistics range in YYYY-MM-DD format (e.g., 2026-02-14)
string
required
Start date for statistics range in YYYY-MM-DD format (e.g., 2026-01-15)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOMO_LIST_EVENTSList notification events from your Fomo application. Supports pagination, sorting, and optional metadata about total event counts.

Input Parameters

integer
Page number to retrieve. Default: 1
string ("created_at" | "event_type_id")
Fields available for ordering events.
integer
Number of events to return per page. Default: 100
boolean
Returns pagination metadata (total_count, total_pages, page, per_page) in meta attribute when enabled
string ("asc" | "desc")
Order direction for sorting events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOMO_SEARCH_EVENTSearch for a single Fomo event by external ID or email address and return the available event details. If the API returns no match, the tool reports an error.

Input Parameters

string
required
Value to match by, e.g., john@gmail.com if field is email_address, or a unique ID if field is external_id
string ("email_address" | "external_id")
required
Single attribute by which to search for an event (email_address or external_id)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Application unique ID
string
Application URL (0-255 characters)
string
Application name (0-255 characters)
string ("theme1" | "theme2" | "custom")
Widget theme options.
boolean
Whether the widget can be closed by users. Default: false
string
Language of application using ISO-2 standard (e.g., ‘en’, ‘es’, ‘fr’). Default: ‘en’
string ("bottom_left" | "bottom_right" | "top_left" | "top_right")
Widget position options.
boolean
Whether the application was installed. Deprecated field, will be removed in future versions.
integer
Delay (in seconds) before the widget is displayed on page load. Default: 1
boolean
Whether to display notifications in random order. Default: false
string
UTM medium parameter for tracking (e.g., Google Analytics). Default: ‘notification’
string
UTM source parameter for tracking (e.g., Google Analytics). Default: ‘fomo’
integer
Delay (in seconds) between display of notifications. Default: 1
boolean
Whether to hide the widget on mobile devices. Default: false
integer ("1" | "2" | "3" | "4")
Time period units for display and time ago settings.
integer ("1" | "2" | "3" | "4")
Time period units for display and time ago settings.
integer
Duration (in seconds) each notification is displayed. Default: 1
string
Maximum number of notifications returned in one API call. Default: ‘30’
integer
Multiplier for display_period to define time limit for displaying notifications. Formula: display_threshold * display_period. Default: 5
boolean
Whether to loop notifications continuously or display them only once. Default: true
integer
Multiplier for time_ago_period to define time limit for displaying notifications. Formula: time_ago_threshold * time_ago_period. Default: 1
array
Array of event type configurations for the application

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the event to update
string
URL to redirect visitor to after clicking the event
string
City where the event happened. Maximum 255 characters.
string
Title of the event. Maximum 255 characters.
string
Country where the event happened (ISO-2 standard). Maximum 255 characters.
string
Province where the event happened. Maximum 255 characters.
string
URL of the image to be displayed. Maximum 255 characters.
string
Time should be in UTC and use ‘2018-01-01 23:00:00Z’ formatting
string
First name of the person on the event
string
Person’s IP address, used to extract city, province, and country parameters
string
Optional identifier, useful for preventing duplicates
string
Person’s email address, used to create dynamic customer avatars. Never shown publicly.
integer
required
Event type unique ID. This is the template ID used for the event notification.
array
Array of custom event fields to add to the event

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not