Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Commit

Permalink
Docs for integrations.settings endpoint (#1473)
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcosSpessatto authored and MartinSchoeler committed Dec 23, 2019
1 parent 25aa015 commit f1fa245
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 0 deletions.
1 change: 1 addition & 0 deletions _data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,7 @@
- config
- custom-fields
- department
- integrations.settings
- inquiries.list
- inquiries.take
- message
Expand Down
1 change: 1 addition & 0 deletions contributing/documentation/documentation-map/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@ Here you can also find what articles are incomplete and missing.
- config
- custom-fields
- department
- integrations.settings
- inquiries.list
- inquiries.take
- message
Expand Down
1 change: 1 addition & 0 deletions developer-guides/rest-api/livechat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Manage Livechat related data:
| `/api/v1/livechat/department/:_id` | `GET` | Retrieve a Livechat department data. | [info](department/index.html#get-info-about-a-department) |
| `/api/v1/livechat/department/:_id` | `PUT` | Updates a Livechat department data. | [info](department/index.html#update-a-department) |
| `/api/v1/livechat/department/:_id` | `DELETE` | Delete a Livechat department. | [info](department/index.html#removes-a-department) |
| `/api/v1/livechat/integrations.settings` | `GET` | Retrieves a list of integration settings. | [info](integrations-settings/) |
| `/api/v1/livechat/inquiries.list` | `GET` | Retrieves a list of open inquiries. | [info](inquiries-list/) |
| `/api/v1/livechat/inquiries.take` | `POST` | Take an open inquiry. | [info](inquiries-take/) |
| `/api/v1/livechat/sms-incoming/:service` | `POST` | Send SMS messages to Rocket.Chat. | [info](sms-incoming/) |
Expand Down
51 changes: 51 additions & 0 deletions developer-guides/rest-api/livechat/integrations-settings/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Integrations Settings

Retrieves a list of integration settings.

| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
| `/api/v1/livechat/integrations.settings` | `yes` | `GET` |

## Example Call

```bash
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/livechat/integrations.settings
```

## Example Result

```json
{
"settings": [
{
"_id": "Livechat_secret_token",
"_updatedAt": "2019-10-17T13:56:07.285Z",
"autocomplete": true,
"blocked": false,
"createdAt": "2019-10-07T18:52:20.484Z",
"group": "Livechat",
"hidden": false,
"i18nDescription": "Livechat_secret_token_Description",
"i18nLabel": "Secret_token",
"packageValue": "",
"secret": true,
"section": "CRM_Integration",
"sorter": 25,
"ts": "2019-10-07T21:00:01.287Z",
"type": "string",
"value": "",
"valueSource": "meteorSettingsValue",
"meteorSettingsValue": ""
}
],
"success": true
}
```

## Change Log

| Version | Description |
| :--- | :--- |
| 2.2.0 | Added |

0 comments on commit f1fa245

Please sign in to comment.