Skip to content

Commit 487f19b

Browse files
authored
Merge pull request #338 from RitaOC/Rita_main
social login guide
2 parents 64d113d + eb8b691 commit 487f19b

7 files changed

+95
-6
lines changed

docs/links/Facebook_developer.py

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from . import link
2+
3+
link_name = "Facebook developer"
4+
link_text = "Facebook developer"
5+
link_url = "https://developers.facebook.com/products/facebook-login/"
6+
7+
link.xref_links.update({link_name: (link_text, link_url)})

docs/links/Linkedin_developer.py

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from . import link
2+
3+
link_name = "LinkedIn developer"
4+
link_text = "LinkedIn developer"
5+
link_url = "https://www.bing.com/ck/a?!&&p=b2b85466e898e3f3JmltdHM9MTcyODQzMjAwMCZpZ3VpZD0wZmNhOGE5ZC05ODA0LTY0OGYtMjVhYy05ZWQwOTk2MzY1NjYmaW5zaWQ9NTE5Mg&ptn=3&ver=2&hsh=3&fclid=0fca8a9d-9804-648f-25ac-9ed099636566&psq=linkedin+developer+app&u=a1aHR0cHM6Ly9kZXZlbG9wZXIubGlua2VkaW4uY29tLw&ntb=1"
6+
7+
link.xref_links.update({link_name: (link_text, link_url)})

docs/links/X-developer.py

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from . import link
2+
3+
link_name = "X-developer"
4+
link_text = "X-developer"
5+
link_url = "https://developer.twitter.com/en/portal/petition/essential/basic-info/"
6+
7+
link.xref_links.update({link_name: (link_text, link_url)})

docs/plugins/images/API_key.png

6.63 KB
Loading

docs/plugins/images/Call_back.png

6.06 KB
Loading
5.32 KB
Loading

docs/plugins/social_login.rst

+74-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,78 @@
1-
.. vale off
21

3-
Social Login
4-
#############
2+
Social login
3+
############
54

6-
.. image:: images/twilio-sid-authtoken.png
5+
With Mautic's Social Login, Users can easily sign in via their favorite social platforms like Twitter, Facebook, or LinkedIn. The social login feature automatically pre-fills Forms with profile data and updates or creates new Contacts in Mautic, streamlining the user experience.
6+
7+
Before you begin: setup requirements
8+
************************************
9+
10+
Before configuring social login, make sure you have created apps on the developer platforms for the social media profiles you want to integrate:
11+
12+
- :xref:`X-developer`
13+
- :xref:`Facebook developer`
14+
- :xref:`LinkedIn developer`
15+
16+
Once created, you're ready to connect them to Mautic.
17+
18+
Step 1 - authorizing social media Plugins
19+
*****************************************
20+
21+
Before you can use social login, each social media Plugin needs authorization. Here's how to do it:
22+
23+
1. **Copy the Callback URL**: go to Mautic's Plugin configuration window and copy the Callback URL provided there. Paste it into the appropriate field in your developer app setup.
24+
25+
.. image:: images/Call_back.png
726
:width: 400
8-
:alt: Screenshot of the SID and Auth Token fields
27+
:alt: Screenshot of a callback URL input field.
28+
29+
2. **Add Your API Keys**: copy the API Key - Client Key - and API Secret - Client Secret - from the social platform. Paste these keys into the relevant fields in the Mautic Plugin configuration.```
30+
31+
.. image:: images/API_key.png
32+
:width: 400
33+
:alt: Screenshot of an API Key input field.
34+
35+
1. **Authorize the Plugin**: in the Mautic Plugin configuration, click **Authorize**. You must **turn on** the Plugin - do this by toggling the option to “Yes”. Finally, save your configuration to complete the setup.
36+
37+
.. Tip:: You can manage each social network under its respective tab in Mautic's Plugin settings. Make sure each network is fully authorized by adding the required API credentials.
38+
39+
Step 2: adding social login buttons to Forms
40+
********************************************
41+
42+
Having configured the social Plugins, you can add social login buttons to your Mautic Forms.
43+
44+
1. Go to the Forms section in Mautic and either create a new Form or edit an existing one.
45+
46+
2. Select the **Social Login** field from the Form builder. Buttons for all authorized social platforms - for example Twitter, Facebook, LinkedIn automatically appear.
47+
48+
3. When Users log in using their social accounts, Mautic attempts to automatically fill in fields like **Name** or **Email** based on their social profile.
49+
50+
.. image:: images/adding_social_login.png
51+
:alt: Mautic Plugin configuration screen showing authorized status
52+
:width: 400
53+
54+
.. note::
55+
Only the buttons for Plugins you've authorized work in the Form. Ensure you've configured all Integrations correctly for a smooth User experience.
56+
57+
Step 3: configuring features and mapping Contact fields```
58+
*******************************************************
59+
60+
After configuration and authorization of the Plugin, you can customize how Mautic handles the incoming social profile data. Under the **Contact Field Mapping** tab in the Plugin settings, map the fields from the User's social profile - for example Email, Name - to the appropriate Mautic Contact fields.
61+
62+
- You only need to map fields that are relevant to your Form.
63+
64+
- Unmapped fields aren't used to update or create Contacts in Mautic.
65+
66+
Example: map **First Name** from Facebook to **First Name** in Mautic's Contact fields.
67+
68+
Supported social profile fields
69+
*******************************
70+
71+
Each platform provides different user data fields. Here's a quick reference of the fields you can map:
72+
73+
- **Twitter**: profile handle, name, location, description, URL, time zone, language, email address.
74+
75+
- **Facebook**: first name, last name, name, gender, locale, email address, profile link.
76+
77+
- **LinkedIn**: first name, last name, maiden name, formatted name, headline, location, summary, specialties, positions, public profile URL, email address.
978

10-
.. vale on

0 commit comments

Comments
 (0)