Overview
The Mailer Lite connector for Bizagi is available for download at Bizagi Connectors Xchange.
Through this connector, you will be able to connect your Bizagi processes to a www.mailerlite.com account in order to use Mailer Lite's services API.
For more information about this connector's capabilities, visit Bizagi Connectors Xchange.
Before you start
In order to test and use this connector, you will need:
1.Bizagi Studio previously installed.
2.This connector previously installed, via the Connectors Xchange as described at https://help.bizagi.com/platform/en/index.html?Connectors_Xchange.htm, or through a manual installation as described at https://help.bizagi.com/platform/en/index.html?connectors_setup.htm
3.An account at www.mailerlite.com.
a.Make sure you have an API key configured in Bizagi. The API Key must correspond to the one assigned to your Mailer Lite account. In order to obtain it, log in to your Mailer Lite account and then click on your profile at the top right of the screen, select the Integrations option and locate the Developer API section. There you should be able to find or request (if you haven't) your API Key. This instructions can be evidenced in the images below.
Configuring the connector
In order to configure the connector (i.e its authentication parameters), follow the steps presented at the Configuration chapter in https://help.bizagi.com/platform/en/index.html?connectors_setup.htm
For this configuration, consider the following authentication parameters:
•Authentication method: custom.
•api_key: [your_api_key].
|
Note that [your_api_key] corresponds to the one obtained as per instructed in the previous section of this article. |
Using the connector
This connector features 23 available methods of Mailer Lite services.
To learn overall how/where to configure the use of a connector, refer to https://help.bizagi.com/platform/en/index.html?Connectors_Studio.htm.
When using the connector, make sure you consider the following details for each of the available methods.
For more information about any of the method's use, refer to Mailer Lite official documentation at https://developers.mailerlite.com/reference.
Get Campaigns
Obtains all data related to your campaigns.
To configure its inputs, consider:
•CampaignStatus: It is the only mandatory parameter. It is used to specify the status of the campaigns you want to obtain. Its possible values are:
osent
odraft
ooutbox
oif none is specified, it defaults to sent.
•limit: Limits the amount of campaigns returned.
•Offset: Indicates how many campaigns to skip on the result set.
•Order: Specifies the order of the campaigns. Its possible values are:
oASC - for ascending order.
oDESC - for descending order.
To configure its outputs consider mapping:
Get Campaigns count
Obtains the number of campaigns of the specified Status that you have.
To configure its inputs, consider:
•CampaignStatus: It is the only mandatory parameter. It is used to specify the status of the campaigns you want to obtain. Its possible values are:
osent
odraft
ooutbox
oif none is specified, it defaults to sent.
To configure its outputs consider mapping:
Delete Campaign by ID
Allows to delete a specific campaign.
To configure its inputs, consider:
•campaignId: It is the only mandatory parameter. The campaign's ID from the one you want to delete.
To configure its outputs consider mapping:
Put Campaign content
Update a campaign's content
To configure its inputs, consider:
•campaignId: Campaign's ID from the one you want to update.
•html: HTML template source code to replace the one already in place.
•plain: Plain text of the email.
•auto_inline: Defines if it is needed to convert available CSS to inline CSS (excluding media queries).
The first 3 parameters are required for the service invocation to be successful.
To configure its outputs consider mapping:
Post campaign action
Allows to send, cancel or schedule a campaign.
To configure its inputs, consider:
•campaignId: Campaign's ID from the one you want to update.
•action: Action type. The possible values are:
osend
ocancel
•type: schedule type. Possible values are:
o1 - send instantly (if no type is sent this would be the default value).
o2 - schedule send.
•followup_schedule: defines the type of follow-up. Possible values are:
o24h - follow-up mail is sent in 24 hours. (if no followup_schedule is specified this is the default value).
ospecific - follow-up will be done on a specific date which must be provided.
•followup_date: defines the date on which the follow-up will be made. The expected format is yyyy-mm-dd h:i and it is only available fro followup campaigns where the follow_schedule is specific.
•followup_timezone_id: ID of the timezone for the follow-up date.
•analytics: specifies if analytics over the campaign will be performed. Possible values
o0 - False (no).
o1 - True (yes).
•date: specifies the date on which the mail will be sent. The expected format is yyyy-mm-dd h:i. This is only available when the type is 2.
•timezone_id: ID of the timezone. This is only available when the type is 2.
The first 2 parameters are required for the service invocation to be successful.
To configure its outputs consider mapping:
Get groups
Obtains information about your groups.
To configure its inputs, consider:
•limit: Limits the result set of groups to the provided number.
•Offset: skips this amount of groups when generating the result set.
•filters: specify information that the groups need to fulfill in order to be included in the result set.
All parameters are optional.
To configure its outputs consider mapping:
Get group by ID
Obtains information about a specific group.
To configure its inputs, consider:
•groupId: the Id of the specific group you want to retrieve. This parameter is required for the service invocation to be successful.
To configure its outputs consider mapping:
Post new group
Allows the creation of a new Mailer Lite group on your account.
To configure its inputs, consider:
•name: Name of the group that is going to be created. This parameter is required for the service invocation to be successful.
To configure its outputs consider mapping:
Put group name
Updates an existing group's name.
To configure its inputs, consider:
•groupId: ID of the group whose name will be changed. This parameter is required for the service invocation to be successful.
•name: New name for the group that is going to be updated. This parameter is required for the service invocation to be successful.
To configure its outputs consider mapping:
Get subscribers
Obtains the list of subscribers of a group.
To configure its inputs, consider:
•groupId: ID of the group whose subscribers will be obtained. This parameter is required for the service invocation to be successful.
•limit: limits the amount of subscribers obtains.
•offset: defines how many records to skip when yielding results.
•filters: specified information to narrow down the result set.
To configure its outputs consider mapping:
Get subscribers by type
Obtains the list of subscribers of a group that match the provided type.
To configure its inputs, consider:
•groupId: ID of the group whose subscribers will be obtained. This parameter is required for the service invocation to be successful.
•limit: limits the amount of subscribers obtains.
•offset: defines how many records to skip when yielding results.
•filters: specified information to narrow down the result set.
•subsType: specific type of subscriber to obtain. This parameter is required for the service invocation to be successful. Possible values are:
oactive.
ounsubscribed.
obounced.
ojunk.
ounconfirmed.
To configure its outputs consider mapping:
Delete group subscriber
Delete subscribers from a group.
To configure its inputs, consider:
•groupId: ID of the group whose subscriber will be deleted.
•subscriberIdent: ID or email of the subscriber to be deleted from the group.
Both parameters are required for the service invocation to be successful.
To configure its outputs consider mapping:
Post group subscriber
Add subscribers to a group.
To configure its inputs, consider:
•groupId: ID of the group to which a subscriber is going to be added. This parameter is required for the service invocation to be successful.
•email: email of the subscriber to add. This parameter is required for the service invocation to be successful.
•name: name of the subscriber to add. This parameter is required for the service invocation to be successful.
•company: company of the subscriber to add.
•city: city of the subscriber to add.
•resubscribe: boolean value to indicate if the subscriber was a part of the group on the past or not.
•autoresponders: Autoresponders will be sent if the value sent for this parameter is True. This parameter is required for the service invocation to be successful.
•type: type of subscriber. This parameter is required for the service invocation to be successful. Possible values:
ounsubscribed.
oactive.
ounconfirmed.
To configure its outputs consider mapping:
Post group subscribers import
Add multiple subscribers in a single operation to a group.
To configure its inputs, consider:
•groupId: ID of the group to which subscribers is going to be added. This parameter is required for the service invocation to be successful.
•subscribers: collection of subscribers to add.
oemail: email of the subscriber to be added. This parameter is required for the service invocation to be successful.
oname: name of the subscriber to be added.
•resubscribe: boolean value to indicate if the subscribers were part of the group on the past or not.
•autoresponders: Autoresponders will be sent if the value sent for this parameter is True.
To configure its outputs consider mapping:
Post subscriber
Create a subscriber without adding him to a group
To configure its inputs, consider:
•email: email of the subscriber to be created. This parameter is required for the service invocation to be successful.
•name: name of the subscriber to be created.
•company: company of the subscriber to be created.
•city: city of the subscriber to be created.
•resubscribe: boolean value to indicate if the subscriber should be reactivated.
•type: type of the subscriber to be created. This parameter is required for the service invocation to be successful. Possible values are:
ounsubscribed.
oactive.
ounconfirmed.
To configure its outputs consider mapping:
Get subscriber
Obtain a specific subscriber by providing his information.
To configure its inputs, consider:
•subscriberId: ID or email of the user to be obtained. This parameter is required for the service invocation to be successful.
To configure its outputs consider mapping:
Put subscriber
Update a specific subscriber by providing his information.
To configure its inputs, consider:
•subscriberId: ID or email of the user to be updated. This parameter is required for this service invocation to be successful.
•name: new name for the user. This parameter is required for the service invocation to be successful.
•company: new company for the user.
•city: new city for the user.
•resend_autoresponders: boolean value that defines if it is necessary to resend autoresponders.
•type: new type for the user. This parameter is required for the service invocation to be successful. Possible values are:
ounsubscribed.
oactive.
To configure its outputs consider mapping:
Get search subscriber
Obtain the subscribers who match the specified parameters.
To configure its inputs, consider:
•query: text to be used as the search string. This parameter is required for this service invocation to be successful.
•offset: amount of records to skip when yielding results.
•limit: limits the amount of resulting records to this amount.
To configure its outputs consider mapping:
Get subscriber groups
Obtains the list of groups where a given subscriber is present.
To configure its inputs, consider:
•subscriberId: ID or email of the subscriber for whom you wish to obtain the list of groups he belongs to. This parameter is required for this service invocation to be successful.
To configure its outputs consider mapping:
Get subscriber activity
Obtains the activities a subscriber has performed.
To configure its inputs, consider:
•subscriberId: ID or email of the subscriber for whom you wish to obtain the activity. This parameter is required for this service invocation to be successful.
To configure its outputs consider mapping:
Get subscriber activity by type
Obtains the activities a subscriber has performed matching the provided type.
To configure its inputs, consider:
•subscriberId: ID or email of the subscriber for whom you wish to obtain the activity. This parameter is required for this service invocation to be successful.
•activityType: Type of subscriber's activity that you want to obtain. This parameter is required for this service invocation to be successful. Possible values are:
oopens.
oclicks.
ojunks.
obounces.
ounsubscribes.
oforwards.
osendings.
To configure its outputs consider mapping:
Last Updated 10/27/2022 11:30:40 AM