# Fomo

Fomo is a social proof marketing platform that displays real-time user activity notifications on websites to build trust and increase conversions.

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `FOMO`
- **Version:** 20260312_00

## Tools

### Create Fomo Event

**Slug:** `FOMO_CREATE_FOMO_EVENT`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Fomo Template

**Slug:** `FOMO_CREATE_FOMO_TEMPLATE`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Fomo Event

**Slug:** `FOMO_DELETE_FOMO_EVENT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Event unique ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fomo Event

**Slug:** `FOMO_GET_FOMO_EVENT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Event unique id to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fomo Statistics

**Slug:** `FOMO_GET_STATISTICS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_range_to` | string | Yes | End date for statistics range in YYYY-MM-DD format (e.g., 2026-02-14) |
| `date_range_from` | string | Yes | Start date for statistics range in YYYY-MM-DD format (e.g., 2026-01-15) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fomo Events

**Slug:** `FOMO_LIST_EVENTS`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Event

**Slug:** `FOMO_SEARCH_EVENT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Value to match by, e.g., john@gmail.com if field is email_address, or a unique ID if field is external_id |
| `field` | string ("email_address" | "external_id") | Yes | Single attribute by which to search for an event (email_address or external_id) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Application Settings

**Slug:** `FOMO_UPDATE_APPLICATION`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Fomo Event

**Slug:** `FOMO_UPDATE_EVENT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the event to update |
| `url` | string | No | URL to redirect visitor to after clicking the event |
| `city` | string | No | City where the event happened. Maximum 255 characters. |
| `title` | string | No | Title of the event. Maximum 255 characters. |
| `country` | string | No | Country where the event happened (ISO-2 standard). Maximum 255 characters. |
| `province` | string | No | Province where the event happened. Maximum 255 characters. |
| `image_url` | string | No | URL of the image to be displayed. Maximum 255 characters. |
| `created_at` | string | No | Time should be in UTC and use '2018-01-01 23:00:00Z' formatting |
| `first_name` | string | No | First name of the person on the event |
| `ip_address` | string | No | Person's IP address, used to extract city, province, and country parameters |
| `external_id` | string | No | Optional identifier, useful for preventing duplicates |
| `email_address` | string | No | Person's email address, used to create dynamic customer avatars. Never shown publicly. |
| `event_type_id` | integer | Yes | Event type unique ID. This is the template ID used for the event notification. |
| `custom_event_fields_attributes` | array | No | Array of custom event fields to add to the event |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |