Chore: Add Twitter documentation (#648)
* Chore: Add Twitter documentation Co-authored-by: Sojan <sojan@pepalo.com>
BIN
docs/channels/images/twitter/add_agents.png
Normal file
|
After Width: | Height: | Size: 842 KiB |
BIN
docs/channels/images/twitter/authorize_twitter.png
Normal file
|
After Width: | Height: | Size: 944 KiB |
BIN
docs/channels/images/twitter/finish_inbox.png
Normal file
|
After Width: | Height: | Size: 800 KiB |
BIN
docs/channels/images/twitter/inbox_create.png
Normal file
|
After Width: | Height: | Size: 785 KiB |
BIN
docs/channels/images/twitter/inbox_settings.png
Normal file
|
After Width: | Height: | Size: 708 KiB |
BIN
docs/channels/images/twitter/list_of_channels.png
Normal file
|
After Width: | Height: | Size: 839 KiB |
BIN
docs/channels/images/twitter/sign_in_with_twitter.png
Normal file
|
After Width: | Height: | Size: 789 KiB |
32
docs/channels/twitter-channel.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
path: "/docs/channels/twitter"
|
||||
title: "How to create Twitter channel?"
|
||||
---
|
||||
|
||||
**Step 1**. Click on "Add Inbox" button from Settings > Inboxes page.
|
||||
|
||||

|
||||
|
||||
**Step 2**. Click on "Twitter" icon.
|
||||
|
||||

|
||||
|
||||
**Step 3**. Click on "Sign in with Twitter" button
|
||||
|
||||

|
||||
|
||||
**Step 4**. You will be redirected to Twitter, Click on "Authorize app" button.
|
||||
|
||||

|
||||
|
||||
**Step 5**. "Add agents" to your website inbox.
|
||||
|
||||

|
||||
|
||||
**Step 6**. Hooray! You have sucessfully created a Twitter inbox. You will be able to manage Twitter DMs and tweets mentioning you in the Chatwoot Inbox.
|
||||
|
||||

|
||||
|
||||
**Step 7**. If you want to update the agents who have access to the inbox, you can go to Settings > Inboxes.
|
||||
|
||||

|
||||
|
After Width: | Height: | Size: 659 KiB |
BIN
docs/development/project-setup/images/twitter/apps.png
Normal file
|
After Width: | Height: | Size: 613 KiB |
|
After Width: | Height: | Size: 668 KiB |
|
After Width: | Height: | Size: 598 KiB |
|
After Width: | Height: | Size: 835 KiB |
56
docs/development/project-setup/twitter-setup.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
path: "/docs/twitter-app-setup"
|
||||
title: "Twitter App Setup"
|
||||
---
|
||||
|
||||
Twitter channel with Chatwoot requires access to Twitter APIs. We are using Account Activity API. If you don't have an access to Twitter Business APIs, apply for one at [Twitter developer portal](https://developer.twitter.com/en/apply-for-access).
|
||||
|
||||

|
||||
|
||||
Once your application is approved, you will be able to add Twitter Apps and dev environments. If you have applied for a team account, you will able to invite more team members. Inorder for the channel to work you will have to set the following environment variables. We will be describing what it means in the following sections.
|
||||
|
||||
```bash
|
||||
TWITTER_APP_ID=
|
||||
TWITTER_CONSUMER_KEY=
|
||||
TWITTER_CONSUMER_SECRET=
|
||||
TWITTER_ENVIRONMENT=
|
||||
```
|
||||
|
||||
### Create a Twitter App
|
||||
|
||||
URL: https://developer.twitter.com/en/apps/create
|
||||
|
||||
Create a Twitter by filling all the required fields in the above link.
|
||||
|
||||
#### Things to note:
|
||||
|
||||
1. Enable Sign in with Twitter
|
||||
2. Configure the callback url as `{your_chatwoot_installation_url}/twitter/callback`
|
||||
|
||||
After you create the app, you will be able to see a tab `Keys and Tokens`.
|
||||
|
||||
Use `API key` under `Consumer API keys` as `TWITTER_CONSUMER_KEY` in Chatwoot.
|
||||
|
||||
Use `API secret key` under `Consumer API keys` as `TWITTER_CONSUMER_SECRET` in Chatwoot.
|
||||
|
||||

|
||||
|
||||
Go to your apps, you will able to see your app id. Use this app id as `TWITTER_APP_ID` in Chatwoot.
|
||||
|
||||

|
||||
|
||||
### Create a dev environment
|
||||
|
||||
Inorder for the DMs and Tweets to work in realtime, you need to set up Account Activity API dev environment as follows.
|
||||
|
||||
URL: https://developer.twitter.com/en/account/environments
|
||||
|
||||

|
||||
|
||||
Click on `Set up dev environment`. You will be able to see a form as follows.
|
||||
|
||||
Provide a `Dev Environment Label`, this should be an alphanumeric string. Use the same string as `TWITTER_ENVIRONMENT` in Chatwoot.
|
||||
|
||||

|
||||
|
||||
Once you do this, you will ready to use Twitter Channels. To connect your Twitter Account, follow this [guide](/docs/channels/twitter).
|
||||