LeadMagnet/leadchat
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore: Add documentation for API channel (#1179)

Browse Source
This commit is contained in:
Pranav Raj S
2020-08-30 21:46:36 +05:30
committed by GitHub
parent 5ac093fca2
commit 29d13fbb4f
9 changed files with 192 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/channels/api-channel/create-channel.md Normal file
View File

@@ -0,0 +1,34 @@
---
path: '/docs/channels/api/configure'
title: 'How to create an API channel inbox?'
---
Setting up an API channel consists of the following steps.
1. Create API Channel inbox
2. Send messages using Chatwoot APIs
3. Receive webhooks on new messages from Chatwoot
This document allows you to create and configure an API channel inbox in Chatwoot installations.
**Step 1**: Go to Settings > Inboxes and click on "Add Inbox".
**Step 2**: Select **API** from the list of channels.
![select-api-inbox](./images/select-api-inbox.png)
**Step 3**: Provide an name for the channel and a callback URL (the events and corresponding payload is defined in the subsequent articles)
![configure-screen](./images/configure-screen.png)
**Step 4**: Add agents to the inbox.
![add-agents](./images/add-agents.png)
**Step 5**: Hooray!! The inbox setup is complete.
![take-me-there](./images/take-me-there.png)
![inbox-welcome-screen](./images/inbox-welcome-screen.png)
Now the channel setup is complete, let us try to send a message using Chatwoot APIs. Read more about it [here](/docs/channels/api/send-messages)