Notificaciones de campaña

Retrieve all

GET https://whatsbutton.pro/api/notifications/
curl --request GET \
--url 'https://whatsbutton.pro/api/notifications/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Detalles Descripción
search Optional String The search string.
search_by Optional String What field are you searching by. Allowed values are: name.
is_enabled Optional Boolean
type Optional String Allowed values: informational, coupon, live_counter, email_collector, conversions, conversions_counter, video, audio, social_share, reviews, emoji_feedback, cookie_notification, score_feedback, request_collector, countdown_collector, custom_html
datetime_field Optional String Allowed values: datetime, last_datetime
datetime_start Optional String Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Optional String Filter results up to this datetime. Y-m-d H:i:s format.
order_by Optional String What field to order the results by. Allowed values are: notification_id, datetime, last_datetime, name, impressions, hovers, clicks, form_submissions.
order_type Optional String The ordering of the results. Allowed values are: ASC for ascending ordering, and DESC for descending ordering.
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10, 25, 50, 100, 250, 500, 1000. Defaults to 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "campaign_id": 1,
            "notification_key": "f56d2208dd5e9d9809c158e1d6a77f53",
            "name": "Example",
            "type": "reviews",
            "settings": {},
            "impressions": 0,
            "hovers": 0,
            "clicks": 0,
            "form_submissions": 0,
            "is_enabled": true,
            "datetime": "2026-08-30 05:22:48",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://whatsbutton.pro/api/notifications?page=1",
        "last": "https://whatsbutton.pro/api/notifications?page=1",
        "next": null,
        "prev": null,
        "self": "https://whatsbutton.pro/api/notifications?page=1"
    }
}

Retrieve one

GET https://whatsbutton.pro/api/notifications/{notification_id}
curl --request GET \
--url 'https://whatsbutton.pro/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "f56d2208dd5e9d9809c158e1d6a77f53",
        "name": "Example",
        "type": "reviews",
        "settings": {},
        "impressions": 0,
        "hovers": 0,
        "clicks": 0,
        "form_submissions": 0,
        "is_enabled": true,
        "datetime": "2026-08-30 05:22:48",
    }
}

Create

POST https://whatsbutton.pro/api/notifications
Parameters Detalles Descripción
campaign_id Required Integer -
type Required String Allowed values: informational, coupon, live_counter, email_collector, conversions, conversions_counter, video, audio, social_share, reviews, emoji_feedback, cookie_notification, score_feedback, request_collector, countdown_collector, custom_html
name Optional String -
is_enabled Optional Boolean -
curl --request POST \
--url 'https://whatsbutton.pro/api/notifications' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'type=informational' \
--form 'is_enabled=1' 
{
    "data": {
        "id": 1
    }
}

Update

POST https://whatsbutton.pro/api/notifications/{notification_id}
Parameters Detalles Descripción
name Optional String -
is_enabled Optional Boolean -
trigger_all_pages Optional Boolean -
display_trigger Optional String Allowed values: delay, time_on_site, pageviews, inactivity, exit_intent, scroll, target_visible, click, hover
display_trigger_value Optional String -
display_trigger_selector Optional String Available when: display_trigger = target_visible
display_delay_type_after_close Optional String Allowed values: time_on_site, pageviews
display_delay_value_after_close Optional Integer -
display_frequency Optional String Allowed values: all_time, once_per_session, once_per_browser
direction Optional String Allowed values: rtl, ltr
display_continents Optional Array String -
display_countries Optional Array String -
display_languages Optional Array String -
display_operating_systems Optional Array String -
display_browsers Optional Array String -
display_cities Optional Array String -
display_mobile Optional Boolean -
display_desktop Optional Boolean -
schedule Optional Boolean -
start_date Optional String -
end_date Optional String -
display_duration Optional Integer -
display_position Optional String Allowed values: top_left, top_center, top_right, middle_left, middle_center, middle_right, bottom_left, bottom_center, bottom_right, top, bottom, top_floating, bottom_floating
display_close_button Optional Boolean -
close_button_color Optional String -
dark_mode_close_button_color Optional String -
display_branding Optional Boolean -
shadow Optional String Allowed values: , subtle, feather, 3d, layered
border_width Optional Integer Allowed values: 0, 1, 2, 3, 4, 5
internal_padding Optional Integer Allowed values: 5-25
background_blur Optional Integer Allowed values: 0-30
custom_css Optional String -
hover_animation Optional String Allowed values: , fast_scale_up, slow_scale_up, fast_scale_down, slow_scale_down
on_animation Optional String Allowed values: fadeIn, slideInUp, slideInDown, zoomIn, bounceIn
off_animation Optional String Allowed values: fadeOut, slideOutUp, slideOutDown, zoomOut, bounceOut
animation Optional String Allowed values: , heartbeat, bounce, flash, pulse
animation_interval Optional Integer -
font Optional String Allowed values: inherit, Arial, Verdana, Helvetica, Tahoma, Trebuchet MS, Times New Roman, Georgia, Courier New, Monaco, Comic Sans MS, Courier, Impact, Futura, Luminari, Baskerville, Papyrus
border_radius Optional String Allowed values: straight, rounded, highly_rounded, round
dark_mode_is_enabled Optional Boolean
notifications Optional Array Available when: type = email_collector, collector_bar, collector_modal, collector_two_modal, conversions, inline_conversions, conversions_counter, inline_conversions_counter, countdown_collector, request_collector, text_feedback Notification handler ids
translations[input_key][index]['key'] Optional String Available for all the marked for translation fields.
translations[input_key][index]['value'] Optional String Available for all the marked for translation fields.
conversions / inline_conversions
title Optional String Available when: type = conversions, inline_conversions
description Optional String Available when: type = conversions, inline_conversions
image Optional File Available when: type = conversions, inline_conversions
image_alt Optional String Available when: type = conversions, inline_conversions
url Optional String Available when: type = conversions, inline_conversions
display_time Optional Boolean Available when: type = conversions, inline_conversions
url_new_tab Optional Boolean Available when: type = conversions, inline_conversions
conversions_count Optional Integer Available when: type = conversions, inline_conversions
in_between_delay Optional Integer Available when: type = conversions, inline_conversions
order Optional String Available when: type = conversions, inline_conversions
Allowed values: random, descending
data_trigger_auto Optional Boolean Available when: type = conversions, inline_conversions
data_trigger_auto_type[index] Optional Array String Available when: type = conversions, inline_conversions
Allowed values: exact, contains, starts_with, ends_with
data_trigger_auto_value[index] Optional Array String Available when: type = conversions, inline_conversions
title_color Optional String Available when: type = conversions, inline_conversions
description_color Optional String Available when: type = conversions, inline_conversions
date_color Optional String Available when: type = conversions, inline_conversions
background_color Optional String Available when: type = conversions, inline_conversions
border_color Optional String Available when: type = conversions, inline_conversions
shadow_color Optional String Available when: type = conversions, inline_conversions
dark_mode_title_color Optional String Available when: type = conversions, inline_conversions
dark_mode_description_color Optional String Available when: type = conversions, inline_conversions
dark_mode_date_color Optional String Available when: type = conversions, inline_conversions
dark_mode_background_color Optional String Available when: type = conversions, inline_conversions
dark_mode_border_color Optional String Available when: type = conversions, inline_conversions
dark_mode_shadow_color Optional String Available when: type = conversions, inline_conversions
data_trigger_auto Optional Boolean Available when: type = conversions counter
data_trigger_auto_type[index] Optional Array String Available when: type = conversions, inline_conversions
Allowed values: exact, contains, starts_with, ends_with
data_trigger_auto_value[index] Optional Array String Available when: type = conversions, inline_conversions
rating_summary / inline_rating_summary
description Optional String Available when: type = rating_summary, inline_rating_summary Translatable
average_rating Optional Float Available when: type = rating_summary, inline_rating_summary
reviews_count Optional api_documentation.integer Available when: type = rating_summary, inline_rating_summary
display_minimum_reviews Optional api_documentation.integer Available when: type = rating_summary, inline_rating_summary
url Optional String Available when: type = rating_summary, inline_rating_summary
url_new_tab Optional Boolean Available when: type = rating_summary, inline_rating_summary
selector Optional String Available when: type = inline_rating_summary
inline_placement Optional String Available when: type = inline_rating_summary
rating_color Optional String Available when: type = rating_summary, inline_rating_summary
rating_background_color Optional String Available when: type = rating_summary, inline_rating_summary
stars_color Optional String Available when: type = rating_summary, inline_rating_summary
description_color Optional String Available when: type = rating_summary, inline_rating_summary
background_color Optional String Available when: type = rating_summary, inline_rating_summary
border_color Optional String Available when: type = rating_summary, inline_rating_summary
shadow_color Optional String Available when: type = rating_summary, inline_rating_summary
dark_mode_rating_color Optional String Available when: type = rating_summary, inline_rating_summary
dark_mode_rating_background_color Optional String Available when: type = rating_summary, inline_rating_summary
dark_mode_stars_color Optional String Available when: type = rating_summary, inline_rating_summary
dark_mode_description_color Optional String Available when: type = rating_summary, inline_rating_summary
dark_mode_background_color Optional String Available when: type = rating_summary, inline_rating_summary
dark_mode_border_color Optional String Available when: type = rating_summary, inline_rating_summary
dark_mode_shadow_color Optional String Available when: type = rating_summary, inline_rating_summary
telegram_chat
title Optional String Available when: type = telegram_chat
agent_image Optional File Available when: type = telegram_chat
agent_image_alt Optional String Available when: type = telegram_chat
agent_name Optional String Available when: type = telegram_chat Translatable
agent_description Optional String Available when: type = telegram_chat Translatable
agent_message Optional String Available when: type = telegram_chat Translatable
agent_telegram Optional String Available when: type = telegram_chat Translatable
button_text Optional String Available when: type = telegram_chat Translatable
header_agent_name_color Optional String Available when: type = telegram_chat
header_agent_description_color Optional String Available when: type = telegram_chat
header_background_color Optional String Available when: type = telegram_chat
content_background_color Optional String Available when: type = telegram_chat
content_agent_name_color Optional String Available when: type = telegram_chat
content_agent_message_color Optional String Available when: type = telegram_chat
content_agent_message_background_color Optional String Available when: type = telegram_chat
footer_background_color Optional String Available when: type = telegram_chat
footer_button_background_color Optional String Available when: type = telegram_chat
footer_button_color Optional String Available when: type = telegram_chat
title_color Optional String Available when: type = telegram_chat
background_color Optional String Available when: type = telegram_chat
border_color Optional String Available when: type = telegram_chat
shadow_color Optional String Available when: type = telegram_chat
dark_mode_header_agent_name_color Optional String Available when: type = telegram_chat
dark_mode_header_agent_description_color Optional String Available when: type = telegram_chat
dark_mode_header_background_color Optional String Available when: type = telegram_chat
dark_mode_content_background_color Optional String Available when: type = telegram_chat
dark_mode_content_agent_name_color Optional String Available when: type = telegram_chat
dark_mode_content_agent_message_color Optional String Available when: type = telegram_chat
dark_mode_content_agent_message_background_color Optional String Available when: type = telegram_chat
dark_mode_footer_background_color Optional String Available when: type = telegram_chat
dark_mode_footer_button_background_color Optional String Available when: type = telegram_chat
dark_mode_footer_button_color Optional String Available when: type = telegram_chat
dark_mode_title_color Optional String Available when: type = telegram_chat
dark_mode_background_color Optional String Available when: type = telegram_chat
dark_mode_border_color Optional String Available when: type = telegram_chat
dark_mode_shadow_color Optional String Available when: type = telegram_chat
facebook_messenger_chat
curl --request POST \
--url 'https://whatsbutton.pro/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=example' \
--form 'is_enabled=1' 
{
    "data": {
        "id": 1
    }
}

Delete

DELETE https://whatsbutton.pro/api/notifications/{notification_id}
curl --request DELETE \
--url 'https://whatsbutton.pro/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \