Notificações de campanha

Recuperar tudo

GET https://notifyc.com/api/notifications/
curl --request GET \
--url 'https://notifyc.com/api/notifications/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional String A string de busca.
search_by Opcional String Qual campo você está pesquisando? Os valores permitidos são: name.
is_enabled Opcional Boolean
type Opcional String Valores permitidos: 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, informational_bar, image, collector_bar, coupon_bar, button_bar, collector_modal, collector_two_modal, button_modal, text_feedback, engagement_links, whatsapp_chat, contact_us, informational_mini, informational_bar_mini, badge
datetime_field Opcional String Valores permitidos: datetime, last_datetime
datetime_start Opcional String Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Opcional String Filter results up to this datetime. Y-m-d H:i:s format.
order_by Opcional String Qual campo ordenar os resultados. Os valores permitidos são: notification_id, datetime, last_datetime, name, impressions, hovers, clicks, form_submissions.
order_type Opcional String A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente.
page Opcional Inteiro O número da página de onde você deseja os resultados. O padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10, 25, 50, 100, 250, 500, 1000. O padrão é 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "campaign_id": 1,
            "notification_key": "Example",
            "name": "Example",
            "type": "Example",
            "settings": [],
            "impressions": 1,
            "hovers": 1,
            "clicks": 1,
            "form_submissions": 1,
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-10-21 00:32:37"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://notifyc.com/api/notifications?page=1",
        "last": "https://notifyc.com/api/notifications?page=1",
        "next": null,
        "prev": null,
        "self": "https://notifyc.com/api/notifications?page=1"
    }
}

Recuperar um

GET https://notifyc.com/api/notifications/{notification_id}
curl --request GET \
--url 'https://notifyc.com/api/notifications/{notification_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": [],
        "impressions": 1,
        "hovers": 1,
        "clicks": 1,
        "form_submissions": 1,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:32:37"
    }
}

Criar

POST https://notifyc.com/api/notifications
Parâmetros Detalhes Descrição
campaign_id Requerido Inteiro -
type Requerido String Valores permitidos: 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, informational_bar, image, collector_bar, coupon_bar, button_bar, collector_modal, collector_two_modal, button_modal, text_feedback, engagement_links, whatsapp_chat, contact_us, informational_mini, informational_bar_mini, badge
name Opcional String -
is_enabled Opcional Boolean -
curl --request POST \
--url 'https://notifyc.com/api/notifications' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'type=informational' \
--form 'is_enabled=1' 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": {},
        "impressions": "Example",
        "hovers": "Example",
        "clicks": 1,
        "form_submissions": "Example",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:32:37"
    }
}

Atualizar

POST https://notifyc.com/api/notifications/{notification_id}
Parâmetros Detalhes Descrição
name Opcional String -
is_enabled Opcional Boolean -
trigger_all_pages Opcional Boolean -
display_trigger Opcional String Valores permitidos: delay, time_on_site, pageviews, inactivity, exit_intent, scroll, target_visible, click, hover
display_trigger_value Opcional String -
display_trigger_selector Opcional String Disponível quando: display_trigger = target_visible
display_delay_type_after_close Opcional String Valores permitidos: time_on_site, pageviews
display_delay_value_after_close Opcional Inteiro -
display_focus Opcional Boolean -
display_focus_behavior Opcional String Valores permitidos: visual_only, outside_click_unfocus, lock_until_interaction
display_frequency Opcional String Valores permitidos: all_time, once_per_session, once_per_browser
direction Opcional String Valores permitidos: rtl, ltr
display_continents Opcional Array String -
display_countries Opcional Array String -
display_languages Opcional Array String -
display_operating_systems Opcional Array String -
display_browsers Opcional Array String -
display_cities Opcional Array String -
display_mobile Opcional Boolean -
display_desktop Opcional Boolean -
schedule Opcional Boolean -
start_date Opcional String -
end_date Opcional String -
display_duration Opcional Inteiro -
display_position Opcional String Valores permitidos: 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 Opcional Boolean -
close_button_color Opcional String -
dark_mode_close_button_color Opcional String -
display_branding Opcional Boolean -
shadow Opcional String Valores permitidos: , subtle, feather, 3d, layered
border_width Opcional Inteiro Valores permitidos: 0, 1, 2, 3, 4, 5
internal_padding Opcional Inteiro Valores permitidos: 5-25
background_blur Opcional Inteiro Valores permitidos: 0-30
custom_css Opcional String -
hover_animation Opcional String Valores permitidos: , fast_scale_up, slow_scale_up, fast_scale_down, slow_scale_down
on_animation Opcional String Valores permitidos: fadeIn, slideInUp, slideInDown, zoomIn, bounceIn
off_animation Opcional String Valores permitidos: fadeOut, slideOutUp, slideOutDown, zoomOut, bounceOut
animation Opcional String Valores permitidos: , heartbeat, bounce, flash, pulse
animation_interval Opcional Inteiro -
font Opcional String Valores permitidos: 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 Opcional String Valores permitidos: straight, rounded, highly_rounded, round
dark_mode_is_enabled Opcional Boolean
notifications Opcional Array Disponível quando: type = email_collector, collector_bar, collector_modal, collector_two_modal, conversions, inline_conversions, conversions_counter, inline_conversions_counter, countdown_collector, request_collector, text_feedback IDs do manipulador de notificações
translations[input_key][index]['key'] Opcional String Available for all the marked for translation fields.
translations[input_key][index]['value'] Opcional String Available for all the marked for translation fields.
conversions / inline_conversions
title Opcional String Disponível quando: type = conversions, inline_conversions
description Opcional String Disponível quando: type = conversions, inline_conversions
image Opcional Arquivo Disponível quando: type = conversions, inline_conversions
image_alt Opcional String Disponível quando: type = conversions, inline_conversions
url Opcional String Disponível quando: type = conversions, inline_conversions
display_time Opcional Boolean Disponível quando: type = conversions, inline_conversions
url_new_tab Opcional Boolean Disponível quando: type = conversions, inline_conversions
conversions_count Opcional Inteiro Disponível quando: type = conversions, inline_conversions
in_between_delay Opcional Inteiro Disponível quando: type = conversions, inline_conversions
order Opcional String Disponível quando: type = conversions, inline_conversions
Valores permitidos: random, descending
data_trigger_auto Opcional Boolean Disponível quando: type = conversions, inline_conversions
data_trigger_auto_type[index] Opcional Array String Disponível quando: type = conversions, inline_conversions
Valores permitidos: exact, contains, starts_with, ends_with
data_trigger_auto_value[index] Opcional Array String Disponível quando: type = conversions, inline_conversions
title_color Opcional String Disponível quando: type = conversions, inline_conversions
description_color Opcional String Disponível quando: type = conversions, inline_conversions
date_color Opcional String Disponível quando: type = conversions, inline_conversions
background_color Opcional String Disponível quando: type = conversions, inline_conversions
border_color Opcional String Disponível quando: type = conversions, inline_conversions
shadow_color Opcional String Disponível quando: type = conversions, inline_conversions
dark_mode_title_color Opcional String Disponível quando: type = conversions, inline_conversions
dark_mode_description_color Opcional String Disponível quando: type = conversions, inline_conversions
dark_mode_date_color Opcional String Disponível quando: type = conversions, inline_conversions
dark_mode_background_color Opcional String Disponível quando: type = conversions, inline_conversions
dark_mode_border_color Opcional String Disponível quando: type = conversions, inline_conversions
dark_mode_shadow_color Opcional String Disponível quando: type = conversions, inline_conversions
data_trigger_auto Opcional Boolean Disponível quando: type = conversions counter
data_trigger_auto_type[index] Opcional Array String Disponível quando: type = conversions, inline_conversions
Valores permitidos: exact, contains, starts_with, ends_with
data_trigger_auto_value[index] Opcional Array String Disponível quando: type = conversions, inline_conversions
rating_summary / inline_rating_summary
description Opcional String Disponível quando: type = rating_summary, inline_rating_summary Translatable
average_rating Opcional Flutuante Disponível quando: type = rating_summary, inline_rating_summary
reviews_count Opcional api_documentation.integer Disponível quando: type = rating_summary, inline_rating_summary
display_minimum_reviews Opcional api_documentation.integer Disponível quando: type = rating_summary, inline_rating_summary
url Opcional String Disponível quando: type = rating_summary, inline_rating_summary
url_new_tab Opcional Boolean Disponível quando: type = rating_summary, inline_rating_summary
selector Opcional String Disponível quando: type = inline_rating_summary
inline_placement Opcional String Disponível quando: type = inline_rating_summary
rating_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
rating_background_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
stars_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
description_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
background_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
border_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
shadow_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
dark_mode_rating_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
dark_mode_rating_background_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
dark_mode_stars_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
dark_mode_description_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
dark_mode_background_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
dark_mode_border_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
dark_mode_shadow_color Opcional String Disponível quando: type = rating_summary, inline_rating_summary
telegram_chat
title Opcional String Disponível quando: type = telegram_chat
agent_image Opcional Arquivo Disponível quando: type = telegram_chat
agent_image_alt Opcional String Disponível quando: type = telegram_chat
agent_name Opcional String Disponível quando: type = telegram_chat Translatable
agent_description Opcional String Disponível quando: type = telegram_chat Translatable
agent_message Opcional String Disponível quando: type = telegram_chat Translatable
agent_telegram Opcional String Disponível quando: type = telegram_chat Translatable
button_text Opcional String Disponível quando: type = telegram_chat Translatable
header_agent_name_color Opcional String Disponível quando: type = telegram_chat
header_agent_description_color Opcional String Disponível quando: type = telegram_chat
header_background_color Opcional String Disponível quando: type = telegram_chat
content_background_color Opcional String Disponível quando: type = telegram_chat
content_agent_name_color Opcional String Disponível quando: type = telegram_chat
content_agent_message_color Opcional String Disponível quando: type = telegram_chat
content_agent_message_background_color Opcional String Disponível quando: type = telegram_chat
footer_background_color Opcional String Disponível quando: type = telegram_chat
footer_button_background_color Opcional String Disponível quando: type = telegram_chat
footer_button_color Opcional String Disponível quando: type = telegram_chat
title_color Opcional String Disponível quando: type = telegram_chat
background_color Opcional String Disponível quando: type = telegram_chat
border_color Opcional String Disponível quando: type = telegram_chat
shadow_color Opcional String Disponível quando: type = telegram_chat
dark_mode_header_agent_name_color Opcional String Disponível quando: type = telegram_chat
dark_mode_header_agent_description_color Opcional String Disponível quando: type = telegram_chat
dark_mode_header_background_color Opcional String Disponível quando: type = telegram_chat
dark_mode_content_background_color Opcional String Disponível quando: type = telegram_chat
dark_mode_content_agent_name_color Opcional String Disponível quando: type = telegram_chat
dark_mode_content_agent_message_color Opcional String Disponível quando: type = telegram_chat
dark_mode_content_agent_message_background_color Opcional String Disponível quando: type = telegram_chat
dark_mode_footer_background_color Opcional String Disponível quando: type = telegram_chat
dark_mode_footer_button_background_color Opcional String Disponível quando: type = telegram_chat
dark_mode_footer_button_color Opcional String Disponível quando: type = telegram_chat
dark_mode_title_color Opcional String Disponível quando: type = telegram_chat
dark_mode_background_color Opcional String Disponível quando: type = telegram_chat
dark_mode_border_color Opcional String Disponível quando: type = telegram_chat
dark_mode_shadow_color Opcional String Disponível quando: type = telegram_chat
facebook_messenger_chat
display_continents Opcional String -
display_countries Opcional String -
display_languages Opcional String -
display_operating_systems Opcional String -
display_browsers Opcional String -
display_cities Opcional String -
infinite_rotation Opcional String -
video_is_vimeo Opcional String -
vimeo_video_id Opcional Inteiro -
badge_text Opcional String -
hint_text Opcional String -
items Opcional Array -
trigger_type Opcional String -
trigger_value Opcional Inteiro -
border_color Opcional String -
dark_mode_border_color Opcional String -
shadow_color Opcional String -
dark_mode_shadow_color Opcional String -
title_color Opcional String -
description_color Opcional String -
background_color Opcional String -
dark_mode_title_color Opcional String -
dark_mode_description_color Opcional String -
dark_mode_background_color Opcional String -
margin_top Opcional String -
margin_right Opcional String -
margin_bottom Opcional String -
margin_left Opcional String -
button_background_color Opcional String -
button_color Opcional String -
dark_mode_button_background_color Opcional String -
dark_mode_button_color Opcional String -
number_background_color Opcional String -
number_color Opcional String -
pulse_background_color Opcional String -
dark_mode_number_background_color Opcional String -
dark_mode_number_color Opcional String -
dark_mode_pulse_background_color Opcional String -
date_color Opcional String -
dark_mode_date_color Opcional String -
rating_color Opcional String -
rating_background_color Opcional String -
stars_color Opcional String -
dark_mode_rating_color Opcional String -
dark_mode_rating_background_color Opcional String -
dark_mode_stars_color Opcional String -
content_title_color Opcional String -
content_description_color Opcional String -
dark_mode_content_title_color Opcional String -
dark_mode_content_description_color Opcional String -
time_color Opcional String -
time_background_color Opcional String -
dark_mode_time_color Opcional String -
dark_mode_time_background_color Opcional String -
coupon_code_color Opcional String -
coupon_code_background_color Opcional String -
coupon_code_border_color Opcional String -
dark_mode_coupon_code_color Opcional String -
dark_mode_coupon_code_background_color Opcional String -
dark_mode_coupon_code_border_color Opcional String -
categories_title_color Opcional String -
categories_description_color Opcional String -
categories_links_title_color Opcional String -
categories_links_description_color Opcional String -
categories_links_background_color Opcional String -
categories_links_border_color Opcional String -
dark_mode_categories_title_color Opcional String -
dark_mode_categories_description_color Opcional String -
dark_mode_categories_links_title_color Opcional String -
dark_mode_categories_links_description_color Opcional String -
dark_mode_categories_links_background_color Opcional String -
dark_mode_categories_links_border_color Opcional String -
badge_background_color Opcional String -
badge_color Opcional String -
hint_background_color Opcional String -
hint_color Opcional String -
item_question_color Opcional String -
item_answer_color Opcional String -
item_background_color Opcional String -
item_border_color Opcional String -
dark_mode_badge_background_color Opcional String -
dark_mode_badge_color Opcional String -
dark_mode_hint_background_color Opcional String -
dark_mode_hint_color Opcional String -
dark_mode_item_question_color Opcional String -
dark_mode_item_answer_color Opcional String -
dark_mode_item_background_color Opcional String -
dark_mode_item_border_color Opcional String -
header_agent_name_color Opcional String -
header_agent_description_color Opcional String -
header_background_color Opcional String -
content_background_color Opcional String -
content_agent_name_color Opcional String -
content_agent_message_color Opcional String -
content_agent_message_background_color Opcional String -
footer_background_color Opcional String -
footer_button_background_color Opcional String -
footer_button_color Opcional String -
dark_mode_header_agent_name_color Opcional String -
dark_mode_header_agent_description_color Opcional String -
dark_mode_header_background_color Opcional String -
dark_mode_content_background_color Opcional String -
dark_mode_content_agent_name_color Opcional String -
dark_mode_content_agent_message_color Opcional String -
dark_mode_content_agent_message_background_color Opcional String -
dark_mode_footer_background_color Opcional String -
dark_mode_footer_button_background_color Opcional String -
dark_mode_footer_button_color Opcional String -
curl --request POST \
--url 'https://notifyc.com/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,
        "user_id": 1,
        "campaign_id": 1,
        "notification_key": "Example",
        "name": "Example",
        "type": "Example",
        "settings": {},
        "impressions": 1,
        "hovers": 1,
        "clicks": 1,
        "form_submissions": 1,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-21 00:32:37"
    }
}

Excluir

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