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.

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

Jump to bottom

[docs]: Revamp the documentation of airtable, amazonses and amazons3 #9499

Merged
merged 6 commits into from
Apr 30, 2024
Merged

[docs]: Revamp the documentation of airtable, amazonses and amazons3 #9499

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6b51259
Revamp the documentation of airtable, amazonses and amazons3
2001asjad Apr 25, 2024
2138cc1
implement the changes based on the reviews
2001asjad Apr 26, 2024
926ae02
Merge remote-tracking branch 'origin/develop' into docs/update-airtab…
2001asjad Apr 29, 2024
b75e602
edited the changes to airtable, amazonses, s3 data sources in version…
2001asjad Apr 29, 2024
4497f14
addressed the reviews
2001asjad Apr 30, 2024
b543d1d
align the images to the left
2001asjad Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
90 changes: 57 additions & 33 deletions docs/docs/data-sources/airtable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
id: airtable
title: Airtable
---
<div style={{paddingBottom:'24px'}}>

# Airtable

ToolJet can connect to your Airtable account to read and write data. **Personal Access Token** is required to connect to the Airtable data source on ToolJet. You can generate the Personal Access Token by visiting [Developer Hub from your Airtable profile](https://support.airtable.com/docs/creating-and-using-api-keys-and-access-tokens#understanding-personal-access-token-basic-actions).
ToolJet can connect to your **Airtable** account to read and write data. **Personal Access Token** is required to connect to the Airtable data source on ToolJet. You can generate the Personal Access Token by visiting **[Developer Hub from your Airtable profile](https://support.airtable.com/docs/creating-and-using-api-keys-and-access-tokens#understanding-personal-access-token-basic-actions)**.

<div style={{textAlign: 'center'}}>
<img style={{ border:'0', marginBottom:'15px', borderRadius:'5px', boxShadow: '0px 1px 3px rgba(0, 0, 0, 0.2)' }} className="screenshot-full" src="/img/datasource-reference/airtable/airtableconnect-v2.gif" alt="Airtable Data Source Connection" />
Expand All @@ -17,6 +16,10 @@ ToolJet can connect to your Airtable account to read and write data. **Personal
Airtable API has a rate limit, and at the time of writing this documentation, the limit is five(5) requests per second per base. You can read more about rate limits here **[Airtable API](https://airtable.com/api)**.
:::

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

## Supported Operations

- **[List records](#list-records)**
Expand All @@ -25,21 +28,25 @@ Airtable API has a rate limit, and at the time of writing this documentation, th
- **[Update record](#update-record)**
- **[Delete record](#delete-record)**

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

### List records

This operation returns a list of records from the specified table.

#### Required parameters:

- **Base ID:** To find the Base ID, first visit **airtable.com/api**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd`
- **Base ID:** To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd`

- **Table name:** The name of the table from which you want to fetch the records.

#### Optional parameters:

- **Page size:** The number of records returned in each request. Default is 100 records.

- **offset:** The offset value is used to fetch the next set of records. The offset value is returned in the response of the previous request.
- **Offset:** The offset value is used to fetch the next set of records. The offset value is returned in the response of the previous request.

Example response from Airtable:

Expand Down Expand Up @@ -75,11 +82,15 @@ Example response from Airtable:
}
```

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

### Retrieve record

#### Required parameters:

- **Base ID**: To find the Base ID, first visit **airtable.com/api**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd`
- **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd`

- **Table name**: The name of the table from which you want to fetch the records.

Expand All @@ -99,34 +110,38 @@ Example response from Airtable:
}
```

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

### Create record

#### Required parameters:

- **Base ID**: To find the Base ID, first visit **airtable.com/api**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd`
- **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd`

- **Table name**: The name of the table from which you want to fetch the records.

- **Records**: The records you want to create. The records should be in the form of an array of objects. Each object should have a `fields` key, which contains the fields of the record. The field names should be the same as the field names in the Airtable table.

**Example creating two records:**

```json title="Records"
[
{
"fields": {
"Notes": "sdfdsf",
"Name": "dsfdsf"
}
},
{
"fields": {
"Notes": "note1",
"Name": "dsfdsf"
}
Example creating two records:

```json title="Records"
[
{
"fields": {
"Notes": "sdfdsf",
"Name": "dsfdsf"
}
]
```
},
{
"fields": {
"Notes": "note1",
"Name": "dsfdsf"
}
}
]
```

Query returns the following response when the records are created successfully:

Expand All @@ -153,26 +168,30 @@ Query returns the following response when the records are created successfully:
}
```

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

### Update record

#### Required parameters:

- **Base ID**: To find the Base ID, first visit **airtable.com/api**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd`
- **Base ID**: To find the Base ID, first visit **[Airtable API](https://airtable.com/api)**. Then select the base you want to connect to. The Base ID will be mentioned in the API documentation. Example Base ID: `appDT3UCPffPiSmFd`

- **Table name**: The name of the table from which you want to fetch the records.

- **Record ID**: The ID of the record you want to update.

- **Body**: The fields you want to update. The fields should be in the form of an object. The field names should be the same as the field names in the Airtable table.

**Example updating a record:**
```json title="Body"
{
"Notes": "Example Notes",
"Name": "change"
}
```
Example updating a record:

```json title="Body"
{
"Notes": "Example Notes",
"Name": "change"
}
```

Query returns the following response when the record is updated successfully:

Expand All @@ -187,6 +206,10 @@ Query returns the following response when the record is updated successfully:
}
```

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

### Delete record

#### Required parameters:
Expand All @@ -203,3 +226,4 @@ Query returns the following response when the record is deleted successfully:
id: "recIKsyZgqI4zoqS7"
}
```
</div>
22 changes: 18 additions & 4 deletions docs/docs/data-sources/amazonses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@ id: amazonses
title: Amazon SES
---

# Amazon SES
<div style={{paddingBottom:'24px'}}>

ToolJet can connect to your Amazon SES account to send emails.

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

## Connection
To add a new Amazon SES API datasource, click the **Datasource manager** icon on the left-sidebar of the app builder and click on the `Add datasource` button, then select Amazon SES from the modal that pops up.
To add a new **Amazon SES** API data source, click the **Data sources** icon on the left-sidebar of the app builder and click on the **+Add** button, then select Amazon SES from the modal that pops up.

ToolJet requires the following to connect to Amazon SES:

Expand All @@ -18,17 +22,25 @@ ToolJet requires the following to connect to Amazon SES:

It is recommended to create a new IAM user for the database so that you can control the access levels of ToolJet.

Click on the 'Save' button to save the data source.
Click on the **Save** button to save the data source.

<div style={{textAlign: 'center'}}>

<img className="screenshot-full" src="/img/datasource-reference/amazonses/connection.png" alt="Amazon SES" width="600" />
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/amazonses/connection.png" alt="Amazon SES" />

</div>

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
2001asjad marked this conversation as resolved.
Show resolved Hide resolved

## Supported operations
1. Email service

</div>

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

### Email service
Required parameters:
- Send email to
Expand Down Expand Up @@ -59,3 +71,5 @@ For example: `admin@tooljet.io`
:::info Note
Query should be saved before running.
:::

</div>