Skip to content

chore: Update FAQ for outdated api documentation #545

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.

Sign up for GitHub

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

Merged
sojan-official merged 1 commit into from
Jul 16, 2025
Merged

chore: Update FAQ for outdated api documentation #545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions api-reference/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,9 @@ Platform APIs cannot access accounts or users created via the Chatwoot UI, or by
```ruby
PlatformAppPermissible.create!(platform_app: PlatformApp.find(1), permissible: Account.find(1))
```

### What should I do if the API documentation appears outdated?

If you encounter discrepancies between the API documentation and actual API behavior, we recommend inspecting the actual requests made by the Chatwoot UI through your browser's developer console Network tab to see the exact request format and payload structure that works with the current API, then replicate the same request structure in your integration.

You can contribute back by submitting a [pull request](/contributing-guide/api-documentation) with documentation corrections or by [raising an issue](https://github.com/chatwoot/chatwoot/issues) in our GitHub repository to help keep our API documentation current for everyone.
6 changes: 6 additions & 0 deletions contributing-guide/chatwoot-apis.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,9 @@ Platform APIs cannot access accounts or users created via the Chatwoot UI, or by
```ruby
PlatformAppPermissible.create!(platform_app: PlatformApp.find(1), permissible: Account.find(1))
```

#### What should I do if the API documentation appears outdated?

If you encounter discrepancies between the API documentation and actual API behavior, we recommend inspecting the actual requests made by the Chatwoot UI through your browser's developer console Network tab to see the exact request format and payload structure that works with the current API, then replicate the same request structure in your integration.

You can contribute back by submitting a [pull request](/contributing-guide/api-documentation) with documentation corrections or by [raising an issue](https://github.com/chatwoot/chatwoot/issues) in our GitHub repository to help keep our API documentation current for everyone.