Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated docs on URL shortener #154

Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@

* **List of known Bots** - Mautic has the feature to identify and turn-off tracking for several known bots. To track activity from those bots, remove them from this list. To turn off tracking for other bots, add them here (one per line).

* **URL Shortener** - If you use a URL shortening service like bit.ly for links in SMS messages, enter your access token here.
* **URL Shortener** - If you use a URL shortening service like bit.ly for links in SMS or E_mail messages, enter the full URL (including access key) to your URL shortener that, when queried, returns a plain text shortened URL. For bit.ly users, use ``https://api-ssl.bitly.com/v3/shorten?access_token=[ACCESS_TOKEN]&format=txt&longUrl=``, replacing [ACCESS_TOKEN] with your bit.ly access token. For `YOURLS <https://yourls.org>`__ users, your link shortener URL looks like this: ``https://my.shortu.rl/yourls-api.php?signature=XXXXXXXXXX&action=shorturl&format=txt&url=``.

Check failure on line 85 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'E_mail'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'E_mail'?", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 85, "column": 91}}}, "severity": "ERROR"}

Check warning on line 85 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 85, "column": 127}}}, "severity": "INFO"}

Check warning on line 85 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Users' instead of 'users'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Users' instead of 'users'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 85, "column": 239}}}, "severity": "INFO"}

Check warning on line 85 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Users' instead of 'users'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Users' instead of 'users'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 85, "column": 432}}}, "severity": "INFO"}

.. note::

For bit.ly, use the following URL structure: https://api-ssl.bitly.com/v3/shorten?access_token=[ACCESS_TOKEN]&format=txt&longUrl
For bit.ly, use the following URL structure: https://api-ssl.bitly.com/v3/shorten?access_token=[ACCESS_TOKEN]&format=txt&longUrl=

* **Item max lock time** - When a User edits a Campaign, Email, Landing Page, etc., Mautic locks the item to prevent simultaneous edits by other Users. When the initial User saves and closes or cancels out, the item may remain locked for this period of time. The default is ``0 seconds``.

Expand Down