NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

MailerLite

mailerlite

MailerLite is an email marketing service that offers tools for creating and managing email campaigns, automating workflows, and building landing pages.

Email NewslettersMarketing AutomationWeb del proveedor
Acciones
38
Triggers
13
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (38)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create automationMAILERLITE_CREATE_AUTOMATIONAcción

Create automation

Parámetros de entrada

  • namestringObligatorio

    Name of the automation workflow.

  • triggerobjectObligatorio

    Configuration object defining the automation trigger.

  • is_activeboolean

    Whether to activate the automation upon creation. Defaults to false.

Parámetros de salida

  • dataobjectObligatorio

    Full response object from MailerLite API for automation creation.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create/Update E-commerce CustomerMAILERLITE_CREATE_ECOMMERCE_CUSTOMERAcción

Tool to create or update a customer record for a shop. use when syncing shop customers or onboarding new purchases.

Parámetros de entrada

  • emailanyObligatorioemail

    Customer's email address

  • shop_idstringObligatorio

    Unique identifier of the e-commerce shop.

  • total_spentnumber

    Total amount the customer has spent in the shop

  • accepts_marketingboolean

    True if the customer accepts marketing emails, false otherwise

  • create_subscriberboolean

    If true and no subscriber exists, create a subscriber for the customer

Parámetros de salida

  • dataobjectObligatorio

    Details of the created or updated customer

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create E-commerce ShopMAILERLITE_CREATE_ECOMMERCE_SHOPAcción

Tool to connect a new e-commerce shop. use when you need to integrate a store for automations, product imports, and sales tracking.

Parámetros de entrada

  • urlstringObligatorio

    Shop URL address

  • namestringObligatorio

    Shop name

  • enabledboolean

    Enable or disable e-commerce features for the shop.

  • currencyanyObligatorio

    ISO 4217 currency code that the shop uses (e.g., USD, EUR)

  • group_idinteger

    ID of the subscriber group to automatically add shop visitors to.

  • platformstring

    Platform of the shop (e.g., shopify, woocommerce)

  • access_datastring

    Platform-specific credentials (e.g., Shopify token or WooCommerce keys).

  • enable_popupsboolean

    Enable popups on the shop (shop must have the universal script).

Parámetros de salida

  • dataobjectObligatorio

    Created shop details.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create FieldMAILERLITE_CREATE_FIELDAcción

Tool to create a new custom field. use when distinct subscriber attributes are needed before assigning or updating subscriber data. call once per field key.

Parámetros de entrada

  • namestringObligatorio

    Name of the custom field (max 255 characters).

  • typestringObligatorioenum

    Type of the custom field; one of 'text', 'number', or 'date'.

    textnumberdate

Parámetros de salida

  • dataobjectObligatorio

    Details of the created custom field.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create GroupMAILERLITE_CREATE_GROUPAcción

Tool to create a new subscriber group. use after deciding the group name for categorization.

Parámetros de entrada

  • namestringObligatorio

    Name of the new subscriber group (max 255 characters).

Parámetros de salida

  • dataobjectObligatorio

    Details of the created group.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create SegmentMAILERLITE_CREATE_SEGMENTAcción

Tool to create a new subscriber segment. use when grouping subscribers by custom criteria before sending targeted campaigns.

Parámetros de entrada

  • namestringObligatorio

    Name of the new subscriber segment (max 255 characters).

Parámetros de salida

  • dataobjectObligatorio

    Details of the created segment.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create WebhookMAILERLITE_CREATE_WEBHOOKAcción

Tool to register a new webhook url for specified event types. use when you need real-time notifications for selected mailerlite events.

Parámetros de entrada

  • urlanyObligatoriouri

    Endpoint URL where webhook notifications will be sent

  • namestring

    Optional name for the webhook

  • eventsstring[]Obligatorio

    List of events to subscribe to; choose from available webhook events

  • enabledboolean

    Whether the webhook is active; defaults to true

  • batchableboolean

    If true, events will be sent in batches. Required for campaign.open and campaign.click events

Parámetros de salida

  • dataobjectObligatorio

    Schema for a MailerLite webhook resource.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete AutomationMAILERLITE_DELETE_AUTOMATIONAcción

Tool to delete an automation workflow by id. use when you need to remove an automation after confirming it's no longer needed. returns success=true on 204 no content.

Parámetros de entrada

  • automation_idstringObligatorio

    Unique identifier of the automation workflow to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete E-commerce CustomerMAILERLITE_DELETE_ECOMMERCE_CUSTOMERAcción

Tool to delete a customer from an e-commerce shop by ids. use when you need to remove a specific customer from your mailerlite store.

Parámetros de entrada

  • shop_idstringObligatorio

    Unique identifier of the e-commerce shop.

  • customer_idstringObligatorio

    Unique identifier of the customer to delete.

Parámetros de salida

  • dataobjectObligatorio

    Deleted customer details

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete E-commerce ShopMAILERLITE_DELETE_ECOMMERCE_SHOPAcción

Tool to disconnect an e-commerce shop by id. use when you have the shop's unique identifier and want to remove it from your mailerlite account.

Parámetros de entrada

  • shop_idstringObligatorio

    Unique identifier of the e-commerce shop to delete.

Parámetros de salida

  • dataobjectObligatorio

    Deleted e-commerce shop details.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete FieldMAILERLITE_DELETE_FIELDAcción

Tool to delete a custom field. use when a field is obsolete and you need to remove it from your mailerlite account. returns success=true on 204 no content.

Parámetros de entrada

  • field_idstringObligatorio

    Unique identifier of the custom field to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete GroupMAILERLITE_DELETE_GROUPAcción

Tool to delete a subscriber group by id. use when you need to remove an existing subscriber group from your mailerlite account. returns success=true on 204 no content.

Parámetros de entrada

  • group_idstringObligatorio

    The unique identifier of the group to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SegmentMAILERLITE_DELETE_SEGMENTAcción

Tool to delete a segment by id. use when you need to remove an existing segment from your mailerlite account. returns success=true on 204 no content.

Parámetros de entrada

  • segment_idstringObligatorio

    The unique identifier of the segment to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SubscriberMAILERLITE_DELETE_SUBSCRIBERAcción

Tool to delete a subscriber by id. use when you have the subscriber id and want to remove them from your mailerlite account. returns success=true on 204 no content.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the subscriber to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookMAILERLITE_DELETE_WEBHOOKAcción

Tool to remove a webhook subscription by id. use when you need to delete a webhook after confirming it is no longer needed. returns success=true on 204 no content.

Parámetros de entrada

  • webhook_idstringObligatorio

    Unique identifier of the webhook to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Fetch Total E-commerce Customers CountMAILERLITE_FETCH_TOTAL_ECOMMERCE_CUSTOMERS_COUNTAcción

Tool to fetch total ecommerce customers count for a shop. use when only the aggregate count is required without retrieving detailed records.

Parámetros de entrada

  • shop_idstringObligatorio

    Unique identifier of the e-commerce shop.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Account InfoMAILERLITE_GET_ACCOUNT_INFOAcción

Tool to retrieve basic mailerlite account details. use when you need to verify authentication and review account metadata.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Account StatsMAILERLITE_GET_ACCOUNT_STATSAcción

Tool to retrieve usage statistics and performance metrics for the account. use after sending campaigns to analyze engagement and deliverability.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get AutomationMAILERLITE_GET_AUTOMATIONAcción

Tool to retrieve details of a specific automation by id. use when you have the automation id and need its full configuration. example: "get automation 7267552".

Parámetros de entrada

  • fieldsstring

    Comma-separated list of fields to include in the response

  • automation_idstringObligatorio

    Unique identifier of the automation to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Automation detail object

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CampaignsMAILERLITE_GET_CAMPAIGNSAcción

Tool to retrieve a list of all campaigns. use when you need to fetch campaigns optionally filtered by status or type, with pagination.

Parámetros de entrada

  • pageinteger

    Page number (min 1). Defaults to server default (1).

  • limitinteger

    Items per page (min 1). Defaults to server default (25).

  • filter[type]stringenum

    Filter campaigns by type: 'regular', 'ab', 'resend', or 'rss'.

    regularabresendrss
  • filter[status]stringenum

    Filter campaigns by status: 'sent', 'draft', or 'ready'.

    sentdraftready

Parámetros de salida

  • dataobject[]Obligatorio
  • metaobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get E-commerce CustomerMAILERLITE_GET_ECOMMERCE_CUSTOMERAcción

Tool to fetch details of a customer by shop and customer id. use after confirming shop id and customer id.

Parámetros de entrada

  • shop_idintegerObligatorio

    Unique identifier of the e-commerce shop.

  • customer_idintegerObligatorio

    Unique identifier of the customer within the shop.

Parámetros de salida

  • dataobjectObligatorio

    E-commerce customer detail object

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get E-commerce CustomersMAILERLITE_GET_ECOMMERCE_CUSTOMERSAcción

Tool to list customers for a specific shop. use when you need to retrieve and paginate ecommerce customers after you have a shop id. example: "list customers for shop 123".

Parámetros de entrada

  • pageinteger

    Page number to retrieve. Defaults to 1 if not provided.

  • limitinteger

    Number of customers per page. Defaults to server-side default if not provided.

  • shop_idstringObligatorio

    Unique identifier of the e-commerce shop.

Parámetros de salida

  • dataobject[]Obligatorio

    List of customer objects

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get E-commerce ShopMAILERLITE_GET_ECOMMERCE_SHOPAcción

Tool to fetch details of a specific e-commerce shop by id. use when you need detailed configuration or stats of a connected shop.

Parámetros de entrada

  • shop_idstringObligatorio

    Unique identifier of the e-commerce shop.

Parámetros de salida

  • dataobjectObligatorio

    Details of the e-commerce shop.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get E-commerce ShopsMAILERLITE_GET_ECOMMERCE_SHOPSAcción

Tool to list all e-commerce shops connected to the account. use when you need to retrieve and paginate shop listings for an account.

Parámetros de entrada

  • pageinteger

    Page number to retrieve. Defaults to 1 if not provided.

  • limitinteger

    Number of items per page. Defaults to 50 if not provided.

Parámetros de salida

  • dataobject[]Obligatorio

    List of e-commerce shops.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get FieldsMAILERLITE_GET_FIELDSAcción

Tool to retrieve all custom fields defined in the account. use when you need to list or paginate through subscriber custom fields.

Parámetros de entrada

  • pageinteger

    Page number to retrieve.

  • sortstringenum

    Sort fields by 'name' or 'type'; prepend with '-' for descending order.

    nametype-name-type
  • limitinteger

    Maximum number of fields to return.

  • filter[type]stringenum

    Filter fields by type; one of 'text', 'number', 'date'.

    textnumberdate
  • filter[keyword]string

    Filter fields by keyword (matches name or key).

Parámetros de salida

  • dataobject[]Obligatorio

    Array of field objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get GroupsMAILERLITE_GET_GROUPSAcción

Tool to retrieve all subscriber groups. use when you need to list or paginate through subscriber groups.

Parámetros de entrada

  • pageinteger

    Page number to retrieve (starting from 1).

  • sortstringenum

    Sort results by field. Prepend with '-' for descending order.

    nametotalopen_rateclick_ratecreated_at-name-total-open_rate-click_rate-created_at
  • limitinteger

    Maximum number of groups to return.

  • filter[name]string

    Filter groups by name; returns partial matches.

Parámetros de salida

  • dataobject[]Obligatorio

    List of group objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Group SubscribersMAILERLITE_GET_GROUP_SUBSCRIBERSAcción

Tool to list subscribers within a group by id. use when you need to retrieve subscribers belonging to a specific mailerlite group before targeted campaigns. use after confirming the group id is valid.

Parámetros de entrada

  • limitinteger

    Number of subscribers to return per page.

  • cursorstring

    Cursor token for pagination (from meta.next_cursor).

  • includestring

    Include additional resources. Currently only 'groups'.

  • group_idstringObligatorio

    Unique identifier of the group.

  • filter[status]stringenum

    Filter subscribers by status: active, unsubscribed, unconfirmed, bounced, or junk.

    activeunsubscribedunconfirmedbouncedjunk

Parámetros de salida

  • dataobject[]Obligatorio

    List of subscriber objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get SegmentsMAILERLITE_GET_SEGMENTSAcción

Tool to retrieve all segments in the account. use when you need to list or paginate through segments.

Parámetros de entrada

  • pageinteger

    Page number to retrieve (starting from 1)

  • limitinteger

    Maximum number of segments to return (max 250)

Parámetros de salida

  • dataobject[]Obligatorio

    Array of segment objects

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get SubscribersMAILERLITE_GET_SUBSCRIBERSAcción

Tool to retrieve all subscribers. use after connecting account and when listing subscribers by status or paginating. limited by mailerlite connect api quotas.

Parámetros de entrada

  • limitinteger

    Number of subscribers per page. Defaults to server default (usually 25).

  • cursorstring

    Pagination cursor for next page (from previous response meta.cursor).

  • includestring

    Include additional resources. Currently only 'groups'.

  • filter[status]stringenum

    Filter subscribers by status: active, unsubscribed, unconfirmed, bounced, or junk.

    activeunsubscribedunconfirmedbouncedjunk

Parámetros de salida

  • dataobject[]Obligatorio

    List of subscriber objects.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get WebhooksMAILERLITE_GET_WEBHOOKSAcción

Tool to retrieve all configured webhooks. use when you need to list webhooks for your mailerlite account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    Array of webhook objects.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Double Opt-InMAILERLITE_SET_DOUBLE_OPTINAcción

Tool to enable or disable double opt-in for new subscribers. use when configuring subscription confirmation settings.

Parámetros de entrada

  • double_opt_inbooleanObligatorio

    Enable double opt-in for new subscribers if True, disable if False.

Parámetros de salida

  • dataobjectObligatorio

    Wrapper for the updated double opt-in setting.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update E-commerce CustomerMAILERLITE_UPDATE_ECOMMERCE_CUSTOMERAcción

Tool to update a customer's data for a shop by ids. use when you need to change email, marketing opt-in, or spend totals for an existing customer.

Parámetros de entrada

  • emailstringObligatorio

    Valid email address of the customer.

  • shop_idstringObligatorio

    ID of the e-commerce shop.

  • customer_idstringObligatorio

    ID of the customer to update.

  • total_spentnumber

    Total amount the customer has spent in the shop.

  • accepts_marketingboolean

    True if the customer accepts marketing emails.

  • create_subscriberboolean

    If true, creates or associates a subscriber for this customer.

Parámetros de salida

  • dataobjectObligatorio

    Updated customer data object.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update E-commerce ShopMAILERLITE_UPDATE_ECOMMERCE_SHOPAcción

Tool to update settings of a connected e-commerce shop by id. use when you need to modify shop details (name, url, currency) or toggle features after verifying the shop exists.

Parámetros de entrada

  • urlanyObligatoriouri

    Shop URL address

  • namestringObligatorio

    Shop name

  • enabledboolean

    Enable e-commerce functionality for the shop; defaults to false

  • shop_idstringObligatorio

    ID of the e-commerce shop to update

  • currencyanyObligatorio

    ISO 4217 currency code that the shop uses

  • group_idinteger

    ID of the group that shop subscribers are automatically added to

  • platformstring

    E-commerce platform of the shop (e.g., Shopify)

  • access_datastring

    Platform-specific access credential for the shop

  • enable_popupsboolean

    Enable popups for the shop; defaults to false

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update FieldMAILERLITE_UPDATE_FIELDAcción

Tool to update the title of an existing custom field. use when renaming a field label (e.g., correct typos or rebranding).

Parámetros de entrada

  • namestringObligatorio

    New name for the custom field (max 255 characters)

  • field_idstringObligatorio

    ID of the custom field to update

Parámetros de salida

  • dataobjectObligatorio

    Updated field details

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update GroupMAILERLITE_UPDATE_GROUPAcción

Tool to update a group's name by id. use when renaming an existing group after confirming its id.

Parámetros de entrada

  • idstringObligatorio

    Group's unique identifier

  • namestringObligatorio

    New name for the group (max 255 characters)

Parámetros de salida

  • dataobjectObligatorio

    Details of a subscriber group.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update SegmentMAILERLITE_UPDATE_SEGMENTAcción

Tool to rename an existing segment by id. use when you need to update a segment's name after confirming its id.

Parámetros de entrada

  • idstringObligatorio

    Segment's unique identifier

  • namestringObligatorio

    New name for the segment (max 255 characters)

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update SubscriberMAILERLITE_UPDATE_SUBSCRIBERAcción

Tool to update an existing subscriber's information by id. use when altering subscriber details.

Parámetros de entrada

  • idstringObligatorio

    Subscriber's unique identifier

  • fieldsobject

    Mapping of field names to values; omissions do not remove fields.

  • groupsstring[]

    List of group IDs to assign; subscriber will be removed from others.

  • statusstringenum

    Subscriber status.

    activeunsubscribedunconfirmedbouncedjunk
  • optin_ipstring

    IP address used when subscriber opted in.

  • ip_addressstring

    IP address for subscription record.

  • opted_in_atstring

    Opt-in timestamp in 'YYYY-MM-DD HH:MM:SS' format.

  • subscribed_atstring

    Custom subscription timestamp in 'YYYY-MM-DD HH:MM:SS' format.

  • unsubscribed_atstring

    Unsubscription timestamp in 'YYYY-MM-DD HH:MM:SS' format.

Parámetros de salida

  • dataobjectObligatorio

    Updated subscriber object

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update WebhookMAILERLITE_UPDATE_WEBHOOKAcción

Tool to update an existing mailerlite webhook. use when you need to change its url or event triggers by id.

Parámetros de entrada

  • urlanyObligatoriouri

    Endpoint URL where webhook notifications will be sent

  • namestring

    Optional new name for the webhook

  • eventsstring[]Obligatorio

    List of events to subscribe to; choose from available webhook events

  • enabledboolean

    Whether the webhook should be active; defaults to current setting

  • batchableboolean

    Whether the webhook should use batched deliveries

  • webhook_idstringObligatorio

    ID of the webhook to update

Parámetros de salida

  • dataobjectObligatorio

    Schema for a MailerLite webhook resource.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Triggers (13)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

Campaign Link ClickedMAILERLITE_CAMPAIGN_LINK_CLICKEDTrigger

Triggers when a subscriber clicks a link inside one of the account's campaigns, once per click. Campaign Opened triggers on the open itself.

Configuración

  • campaign_idstring

    Only fire for this campaign. Use `MAILERLITE_GET_CAMPAIGNS` to find the campaign id. Leave unset to fire for every campaign on the account, which for opens and clicks is a high volume of events.

Payload del evento

  • campaignobjectObligatorio

    The campaign the clicked link was in.

  • link_urlstringObligatorio

    The link the subscriber clicked. MailerLite rewrites links for click tracking, so read the value before matching on it — it may be MailerLite's tracking URL rather than the destination.

  • subscriberobjectObligatorio

    The subscriber that clicked the link.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Campaign OpenedMAILERLITE_CAMPAIGN_OPENEDTrigger

Triggers when a subscriber opens one of the account's campaigns, once per open. Opens are counted with a tracking pixel, so mailboxes that block or pre-fetch images make the count unreliable.

Configuración

  • campaign_idstring

    Only fire for this campaign. Use `MAILERLITE_GET_CAMPAIGNS` to find the campaign id. Leave unset to fire for every campaign on the account, which for opens and clicks is a high volume of events.

Payload del evento

  • campaignobjectObligatorio

    The campaign that was opened.

  • subscriberobjectObligatorio

    The subscriber that opened the campaign.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Campaign SentMAILERLITE_CAMPAIGN_SENTTrigger

Triggers when a campaign finishes sending to its audience, once per campaign rather than once per recipient.

Configuración

Sin parámetros.

Payload del evento

  • datestringObligatorio

    When the campaign was sent.

  • idstringObligatorio

    MailerLite's id for the campaign. List the account's campaigns with `MAILERLITE_GET_CAMPAIGNS`.

  • namestringObligatorio

    The campaign's name.

  • preview_urlstringObligatorio

    Public URL to preview the campaign's rendered content.

  • total_recipientsintegerObligatorio

    How many subscribers the campaign was sent to.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber Added To GroupMAILERLITE_SUBSCRIBER_ADDED_TO_GROUPTrigger

Triggers when a subscriber is added to one of the account's groups. Membership changes made through MailerLite's API have been observed not to trigger it, only ones made through a form, a landing page or the MailerLite app.

Configuración

  • group_idstring

    Only fire for this group. Use `MAILERLITE_GET_GROUPS` to find the group id. Leave unset to fire for every group on the account.

Payload del evento

  • groupobjectObligatorio

    The group the subscriber was added to.

  • subscriberobjectObligatorio

    The subscriber that joined the group.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber BouncedMAILERLITE_SUBSCRIBER_BOUNCEDTrigger

Triggers when an email MailerLite sent to a subscriber bounces: a real delivery failure reported back by the receiving mailbox, not a status set through the API.

Configuración

Sin parámetros.

Payload del evento

  • click_ratenumberObligatorio

    Click rate for this subscriber, 0..1.

  • clicks_countintegerObligatorio

    Count of campaign link clicks by this subscriber.

  • created_atstringObligatorio

    When the subscriber record was created.

  • deleted_atstring

    When the subscriber was deleted; null on a live subscriber.

  • emailstringObligatorio

    The subscriber's email address.

  • fieldsobjectObligatorio

    The account's custom fields for this subscriber. An open map: keys are whatever custom fields the account defines, values are string, number, date or null. List the definitions with `MAILERLITE_GET_FIELDS`.

  • forget_atstring

    When the subscriber's data is scheduled to be erased under MailerLite's forget path; null otherwise.

  • idstringObligatorio

    MailerLite's id for the subscriber, a numeric string. Read the full record with `MAILERLITE_GET_SUBSCRIBER`.

  • ip_addressstring

    IP the subscriber signed up from. Null for API-created subscribers; populated for web-form signups.

  • locationobject

    Geo-IP location resolved at signup: `id`, `title`, `country_name`, `continent_name`, `state_name`, `time_zone`. Null for every API-created subscriber; populated for web-form signups.

  • open_ratenumberObligatorio

    Open rate for this subscriber, 0..1.

  • opens_countintegerObligatorio

    Count of campaign opens by this subscriber.

  • opted_in_atstring

    When the subscriber confirmed a double opt-in; null when the account does not use double opt-in.

  • optin_ipstring

    IP the double opt-in was confirmed from; null when unused.

  • sentintegerObligatorio

    Count of campaigns sent to this subscriber.

  • sourcestringObligatorio

    How the subscriber entered the account. Five values observed live: `api`, `webform`, `ecommerce`, `import`, `manual`. MailerLite documents no enum.

  • statusstringObligatorio

    Current subscriber status. MailerLite documents the set as `active`, `unsubscribed`, `unconfirmed`, `bounced`, `junk`.

  • subscribed_atstringObligatorio

    When the subscriber subscribed.

  • unsubscribed_atstring

    When the subscriber unsubscribed; null until they do.

  • updated_atstringObligatorio

    When the subscriber record last changed. Equal to `created_at` on a fresh create, which is the cheap way to drop the duplicate Subscriber Updated that a create with `fields` also emits.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber Completed AutomationMAILERLITE_SUBSCRIBER_COMPLETED_AUTOMATIONTrigger

Triggers when a subscriber reaches the end of one of the account's automations. Subscriber Entered Automation triggers when they start one.

Configuración

  • automation_idstring

    Only fire for this automation. Use `MAILERLITE_LIST_AUTOMATIONS` to find the automation id. Leave unset to fire for every automation on the account.

Payload del evento

  • automationobjectObligatorio

    The automation the subscriber completed.

  • subscriberobjectObligatorio

    The subscriber that finished the automation.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber CreatedMAILERLITE_SUBSCRIBER_CREATEDTrigger

Triggers when a subscriber is added to the account through any origin: the API, an import, a signup form, a landing page or the MailerLite app. Creating a subscriber with custom fields in the same call also triggers Subscriber Updated for them.

Configuración

  • sourcestring[]

    Only fire for subscribers that arrived this way, e.g. `['webform']` to skip the ones your own integration writes. MailerLite sets the origin itself and documents no fixed list; the values seen in practice are `api`, `webform`, `ecommerce`, `import`, `manual` and `subscribe app`. Leave unset to fire for every origin.

  • statusstring[]

    Only fire for subscribers created in these states, e.g. `['active']` to skip the ones still to confirm a double opt-in. One or more of `active`, `unconfirmed`, `unsubscribed`, `bounced`, `junk`. Leave unset to fire for every state.

Payload del evento

  • click_ratenumberObligatorio

    Click rate for this subscriber, 0..1.

  • clicks_countintegerObligatorio

    Count of campaign link clicks by this subscriber.

  • created_atstringObligatorio

    When the subscriber record was created.

  • deleted_atstring

    When the subscriber was deleted; null on a live subscriber.

  • emailstringObligatorio

    The subscriber's email address.

  • fieldsobjectObligatorio

    The account's custom fields for this subscriber. An open map: keys are whatever custom fields the account defines, values are string, number, date or null. List the definitions with `MAILERLITE_GET_FIELDS`.

  • forget_atstring

    When the subscriber's data is scheduled to be erased under MailerLite's forget path; null otherwise.

  • idstringObligatorio

    MailerLite's id for the subscriber, a numeric string. Read the full record with `MAILERLITE_GET_SUBSCRIBER`.

  • ip_addressstring

    IP the subscriber signed up from. Null for API-created subscribers; populated for web-form signups.

  • locationobject

    Geo-IP location resolved at signup: `id`, `title`, `country_name`, `continent_name`, `state_name`, `time_zone`. Null for every API-created subscriber; populated for web-form signups.

  • open_ratenumberObligatorio

    Open rate for this subscriber, 0..1.

  • opens_countintegerObligatorio

    Count of campaign opens by this subscriber.

  • opted_in_atstring

    When the subscriber confirmed a double opt-in; null when the account does not use double opt-in.

  • optin_ipstring

    IP the double opt-in was confirmed from; null when unused.

  • sentintegerObligatorio

    Count of campaigns sent to this subscriber.

  • sourcestringObligatorio

    How the subscriber entered the account. Five values observed live: `api`, `webform`, `ecommerce`, `import`, `manual`. MailerLite documents no enum.

  • statusstringObligatorio

    Current subscriber status. MailerLite documents the set as `active`, `unsubscribed`, `unconfirmed`, `bounced`, `junk`.

  • subscribed_atstringObligatorio

    When the subscriber subscribed.

  • unsubscribed_atstring

    When the subscriber unsubscribed; null until they do.

  • updated_atstringObligatorio

    When the subscriber record last changed. Equal to `created_at` on a fresh create, which is the cheap way to drop the duplicate Subscriber Updated that a create with `fields` also emits.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber DeletedMAILERLITE_SUBSCRIBER_DELETEDTrigger

Triggers when a subscriber is deleted, or their data is erased through MailerLite's forget path. The payload still carries the email address and custom fields being erased.

Configuración

Sin parámetros.

Payload del evento

  • subscriberobjectObligatorio

    The subscriber as they stood when they were removed, still carrying the email address and custom fields being erased.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber Entered AutomationMAILERLITE_SUBSCRIBER_ENTERED_AUTOMATIONTrigger

Triggers when a subscriber enters one of the account's automations. Subscriber Completed Automation triggers when they reach the end of one.

Configuración

  • automation_idstring

    Only fire for this automation. Use `MAILERLITE_LIST_AUTOMATIONS` to find the automation id. Leave unset to fire for every automation on the account.

Payload del evento

  • automationobjectObligatorio

    The automation the subscriber entered.

  • subscriberobjectObligatorio

    The subscriber that entered the automation.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber Removed From GroupMAILERLITE_SUBSCRIBER_REMOVED_FROM_GROUPTrigger

Triggers when a subscriber is removed from one of the account's groups. Membership changes made through MailerLite's API have been observed not to trigger it, only ones made through a form, a landing page or the MailerLite app.

Configuración

  • group_idstring

    Only fire for this group. Use `MAILERLITE_GET_GROUPS` to find the group id. Leave unset to fire for every group on the account.

Payload del evento

  • groupobjectObligatorio

    The group the subscriber was removed from.

  • subscriberobjectObligatorio

    The subscriber that left the group.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber Reported SpamMAILERLITE_SUBSCRIBER_REPORTED_SPAMTrigger

Triggers when a subscriber marks one of the account's campaigns as spam: a complaint fed back by the receiving mailbox, not a status set through the API.

Configuración

Sin parámetros.

Payload del evento

  • click_ratenumberObligatorio

    Click rate for this subscriber, 0..1.

  • clicks_countintegerObligatorio

    Count of campaign link clicks by this subscriber.

  • created_atstringObligatorio

    When the subscriber record was created.

  • deleted_atstring

    When the subscriber was deleted; null on a live subscriber.

  • emailstringObligatorio

    The subscriber's email address.

  • fieldsobjectObligatorio

    The account's custom fields for this subscriber. An open map: keys are whatever custom fields the account defines, values are string, number, date or null. List the definitions with `MAILERLITE_GET_FIELDS`.

  • forget_atstring

    When the subscriber's data is scheduled to be erased under MailerLite's forget path; null otherwise.

  • idstringObligatorio

    MailerLite's id for the subscriber, a numeric string. Read the full record with `MAILERLITE_GET_SUBSCRIBER`.

  • ip_addressstring

    IP the subscriber signed up from. Null for API-created subscribers; populated for web-form signups.

  • locationobject

    Geo-IP location resolved at signup: `id`, `title`, `country_name`, `continent_name`, `state_name`, `time_zone`. Null for every API-created subscriber; populated for web-form signups.

  • open_ratenumberObligatorio

    Open rate for this subscriber, 0..1.

  • opens_countintegerObligatorio

    Count of campaign opens by this subscriber.

  • opted_in_atstring

    When the subscriber confirmed a double opt-in; null when the account does not use double opt-in.

  • optin_ipstring

    IP the double opt-in was confirmed from; null when unused.

  • sentintegerObligatorio

    Count of campaigns sent to this subscriber.

  • sourcestringObligatorio

    How the subscriber entered the account. Five values observed live: `api`, `webform`, `ecommerce`, `import`, `manual`. MailerLite documents no enum.

  • statusstringObligatorio

    Current subscriber status. MailerLite documents the set as `active`, `unsubscribed`, `unconfirmed`, `bounced`, `junk`.

  • subscribed_atstringObligatorio

    When the subscriber subscribed.

  • unsubscribed_atstring

    When the subscriber unsubscribed; null until they do.

  • updated_atstringObligatorio

    When the subscriber record last changed. Equal to `created_at` on a fresh create, which is the cheap way to drop the duplicate Subscriber Updated that a create with `fields` also emits.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber UnsubscribedMAILERLITE_SUBSCRIBER_UNSUBSCRIBEDTrigger

Triggers when a subscriber opts out of the account's mailings. MailerLite sends this instead of Subscriber Updated, so it is the only trigger that sees an opt-out.

Configuración

Sin parámetros.

Payload del evento

  • click_ratenumberObligatorio

    Click rate for this subscriber, 0..1.

  • clicks_countintegerObligatorio

    Count of campaign link clicks by this subscriber.

  • created_atstringObligatorio

    When the subscriber record was created.

  • deleted_atstring

    When the subscriber was deleted; null on a live subscriber.

  • emailstringObligatorio

    The subscriber's email address.

  • fieldsobjectObligatorio

    The account's custom fields for this subscriber. An open map: keys are whatever custom fields the account defines, values are string, number, date or null. List the definitions with `MAILERLITE_GET_FIELDS`.

  • forget_atstring

    When the subscriber's data is scheduled to be erased under MailerLite's forget path; null otherwise.

  • idstringObligatorio

    MailerLite's id for the subscriber, a numeric string. Read the full record with `MAILERLITE_GET_SUBSCRIBER`.

  • ip_addressstring

    IP the subscriber signed up from. Null for API-created subscribers; populated for web-form signups.

  • locationobject

    Geo-IP location resolved at signup: `id`, `title`, `country_name`, `continent_name`, `state_name`, `time_zone`. Null for every API-created subscriber; populated for web-form signups.

  • open_ratenumberObligatorio

    Open rate for this subscriber, 0..1.

  • opens_countintegerObligatorio

    Count of campaign opens by this subscriber.

  • opted_in_atstring

    When the subscriber confirmed a double opt-in; null when the account does not use double opt-in.

  • optin_ipstring

    IP the double opt-in was confirmed from; null when unused.

  • sentintegerObligatorio

    Count of campaigns sent to this subscriber.

  • sourcestringObligatorio

    How the subscriber entered the account. Five values observed live: `api`, `webform`, `ecommerce`, `import`, `manual`. MailerLite documents no enum.

  • statusstringObligatorio

    Current subscriber status. MailerLite documents the set as `active`, `unsubscribed`, `unconfirmed`, `bounced`, `junk`.

  • subscribed_atstringObligatorio

    When the subscriber subscribed.

  • unsubscribed_atstring

    When the subscriber unsubscribed; null until they do.

  • updated_atstringObligatorio

    When the subscriber record last changed. Equal to `created_at` on a fresh create, which is the cheap way to drop the duplicate Subscriber Updated that a create with `fields` also emits.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.

Subscriber UpdatedMAILERLITE_SUBSCRIBER_UPDATEDTrigger

Triggers when a subscriber's custom fields are written, or when they confirm a double opt-in. Group changes, bounces, spam reports, deletions and opt-outs each have their own trigger and do not trigger this one.

Configuración

  • sourcestring[]

    Only fire for subscribers that arrived this way, e.g. `['webform']` to skip the ones your own integration writes. MailerLite sets the origin itself and documents no fixed list; the values seen in practice are `api`, `webform`, `ecommerce`, `import`, `manual` and `subscribe app`. Leave unset to fire for every origin.

Payload del evento

  • click_ratenumberObligatorio

    Click rate for this subscriber, 0..1.

  • clicks_countintegerObligatorio

    Count of campaign link clicks by this subscriber.

  • created_atstringObligatorio

    When the subscriber record was created.

  • deleted_atstring

    When the subscriber was deleted; null on a live subscriber.

  • emailstringObligatorio

    The subscriber's email address.

  • fieldsobjectObligatorio

    The account's custom fields for this subscriber. An open map: keys are whatever custom fields the account defines, values are string, number, date or null. List the definitions with `MAILERLITE_GET_FIELDS`.

  • forget_atstring

    When the subscriber's data is scheduled to be erased under MailerLite's forget path; null otherwise.

  • idstringObligatorio

    MailerLite's id for the subscriber, a numeric string. Read the full record with `MAILERLITE_GET_SUBSCRIBER`.

  • ip_addressstring

    IP the subscriber signed up from. Null for API-created subscribers; populated for web-form signups.

  • locationobject

    Geo-IP location resolved at signup: `id`, `title`, `country_name`, `continent_name`, `state_name`, `time_zone`. Null for every API-created subscriber; populated for web-form signups.

  • open_ratenumberObligatorio

    Open rate for this subscriber, 0..1.

  • opens_countintegerObligatorio

    Count of campaign opens by this subscriber.

  • opted_in_atstring

    When the subscriber confirmed a double opt-in; null when the account does not use double opt-in.

  • optin_ipstring

    IP the double opt-in was confirmed from; null when unused.

  • sentintegerObligatorio

    Count of campaigns sent to this subscriber.

  • sourcestringObligatorio

    How the subscriber entered the account. Five values observed live: `api`, `webform`, `ecommerce`, `import`, `manual`. MailerLite documents no enum.

  • statusstringObligatorio

    Current subscriber status. MailerLite documents the set as `active`, `unsubscribed`, `unconfirmed`, `bounced`, `junk`.

  • subscribed_atstringObligatorio

    When the subscriber subscribed.

  • unsubscribed_atstring

    When the subscriber unsubscribed; null until they do.

  • updated_atstringObligatorio

    When the subscriber record last changed. Equal to `created_at` on a fresh create, which is the cheap way to drop the duplicate Subscriber Updated that a create with `fields` also emits.

Instrucciones

- Connect a MailerLite API key whose access matches the data you want forwarded. A MailerLite webhook covers the whole account and offers no per-group or per-campaign filter of its own. - MailerLite batches its deliveries: events arrive around 30 seconds after they happen, not instantly.