mirror of
https://github.com/ToolJet/ToolJet
synced 2026-05-24 01:18:23 +00:00
Merge pull request #10726 from ToolJet/docs/update
[docs]: Update data-sources guides - airtable, amazon s3, amazon ses
This commit is contained in:
Johnson Cherian
GitHub
commit
6e899c3f01
9 changed files with 104 additions and 317 deletions
|
|
@ -2,7 +2,6 @@
|
|||
id: airtable
|
||||
title: Airtable
|
||||
---
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
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)**.
|
||||
|
||||
|
|
@ -16,9 +15,7 @@ ToolJet can connect to your **Airtable** account to read and write data. **Perso
|
|||
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'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Supported Operations
|
||||
|
||||
|
|
@ -30,7 +27,7 @@ Airtable API has a rate limit, and at the time of writing this documentation, th
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
### List records
|
||||
|
||||
|
|
@ -39,19 +36,16 @@ This operation returns a list of records from the specified table.
|
|||
#### Required parameters:
|
||||
|
||||
- **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.
|
||||
|
||||
- **Filter by formula:** This parameter will only return records that satisfy the formula. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error!, the record will be included in the result. e.g. `Name = 'John'`
|
||||
|
||||
- **Fields:** The fields you want to retrieve. If you don't specify the fields, all fields will be returned. e.g. `["Name", "Email", "Survey Response"]`
|
||||
|
||||
<br/>
|
||||
<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/list-records-v2.png" alt="Airtable List Records Query" />
|
||||
</div>
|
||||
|
|
@ -64,24 +58,24 @@ Example response from Airtable:
|
|||
{
|
||||
"id": "recu9xMnUdr2n2cw8",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dsfdsf"
|
||||
"Notes": "Meeting to discuss project details",
|
||||
"Name": "John Doe"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
},
|
||||
{
|
||||
"id": "recyIdR7bVdQvmKXa",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dfds"
|
||||
"Notes": "Follow-up call regarding contract",
|
||||
"Name": "Jane Smith"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
},
|
||||
{
|
||||
"id": "recAOzdIHaRpvRaGE",
|
||||
"fields": {
|
||||
"Notes": "sdfsdfsd",
|
||||
"Name": "sdfdsf"
|
||||
"Notes": "Client feedback review meeting",
|
||||
"Name": "Alice Johnson"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
}
|
||||
|
|
@ -92,16 +86,12 @@ 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 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 retrieve.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
|
@ -115,27 +105,21 @@ Example response from Airtable:
|
|||
{
|
||||
"id": "recu9xMnUdr2n2cw8",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dsfdsf"
|
||||
"Notes": "Discuss project timeline",
|
||||
"Name": "Michael Scott"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Create record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to create the record.
|
||||
|
||||
- **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.
|
||||
|
||||
<br/>
|
||||
<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/create-record-v2.png" alt="Airtable Create Record Query" />
|
||||
</div>
|
||||
|
|
@ -169,22 +153,15 @@ Query returns the following response when the record is created successfully:
|
|||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Update record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to update the record.
|
||||
|
||||
- **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.
|
||||
|
||||
<br/>
|
||||
<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/update-record-v2.png" alt="Airtable Update Record Query" />
|
||||
</div>
|
||||
|
|
@ -215,20 +192,14 @@ Query returns the following response when the record is updated successfully:
|
|||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Delete record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to delete the record.
|
||||
|
||||
- **Record ID**: The ID of the record you want to delete.
|
||||
|
||||
<br/>
|
||||
<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/delete-record-v2.png" alt="Airtable Delete Record Query" />
|
||||
</div>
|
||||
|
|
@ -240,5 +211,4 @@ Query returns the following response when the record is deleted successfully:
|
|||
deleted: true
|
||||
id: "recIKsyZgqI4zoqS7"
|
||||
}
|
||||
```
|
||||
</div>
|
||||
```
|
||||
|
|
@ -3,13 +3,9 @@ id: amazonses
|
|||
title: Amazon SES
|
||||
---
|
||||
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
ToolJet can connect to your Amazon SES account to send emails.
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Connection
|
||||
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.
|
||||
|
|
@ -32,17 +28,16 @@ Click on the **Save** button to save the data source.
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Supported operations
|
||||
1. Email service
|
||||
|
||||
### Email service
|
||||
Required parameters:
|
||||
- Send email to
|
||||
- Send email from
|
||||
- Subject
|
||||
- Body as text
|
||||
- **Send email to**
|
||||
- **Send email from**
|
||||
- **Subject**
|
||||
- **Body as text**
|
||||
|
||||
|
||||
Optional parameters:
|
||||
|
|
|
|||
|
|
@ -2,17 +2,14 @@
|
|||
id: s3
|
||||
title: Amazon S3
|
||||
---
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
ToolJet can connect to **Amazon S3** buckets and perform various operation on them.
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px',}}>
|
||||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the Amazon S3 data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard.
|
||||
To establish a connection with the **Amazon S3** data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard.
|
||||
|
||||
ToolJet supports connecting to AWS S3 using **IAM Access Keys**, **AWS Instance Credentials** or **AWS ARN Role**.
|
||||
|
||||
|
|
@ -52,7 +49,7 @@ You can now connect to **[different S3 Hosts using custom endpoints](/docs/how-t
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Querying AWS S3
|
||||
|
||||
|
|
@ -72,7 +69,7 @@ Query results can be transformed using transformations. Read our [transformation
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Query operations
|
||||
|
||||
|
|
@ -88,8 +85,6 @@ You can create query for AWS S3 data source to perform several actions such as:
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Create a new bucket
|
||||
|
||||
You can create a new bucket in your S3 by using this operation.
|
||||
|
|
@ -104,10 +99,6 @@ You can create a new bucket in your S3 by using this operation.
|
|||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Read object
|
||||
|
||||
You can read an object in a bucket by using this operation.
|
||||
|
|
@ -119,13 +110,9 @@ You can read an object in a bucket by using this operation.
|
|||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/readv2-v3.png" alt="aws s3 read object" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/readv2-v3.png" alt="aws s3 read object" />
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Upload object
|
||||
|
||||
You can use this operation to upload objects(files) to your S3 bucket.
|
||||
|
|
@ -139,13 +126,9 @@ You can use this operation to upload objects(files) to your S3 bucket.
|
|||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/uplobjv2-v3.png" alt="aws s3 upload"/>
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/uplobjv2-v3.png" alt="aws s3 upload"/>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Remove object
|
||||
|
||||
You can use this operation to remove an object from your S3 bucket.
|
||||
|
|
@ -157,27 +140,19 @@ You can use this operation to remove an object from your S3 bucket.
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/removeobject.png" alt="Create a new bucket - S3 operation" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/removeobject.png" alt="Create a new bucket - S3 operation" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### List buckets
|
||||
|
||||
This operation will list all the buckets in your S3. This does not require any parameter.
|
||||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/listbucketsv2-v3.png" alt="aws s3 bucket" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/listbucketsv2-v3.png" alt="aws s3 bucket" />
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### List objects in a bucket
|
||||
|
||||
This operation will fetch the list of all the files in your bucket. It requires the following parameters:
|
||||
|
|
@ -205,15 +180,11 @@ The results will continue from where the last listing finished.
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/listobjectsv2-v3.png" alt="aws s3 list object" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/listobjectsv2-v3.png" alt="aws s3 list object" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Signed url for download
|
||||
### Signed URL for download
|
||||
|
||||
The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects.
|
||||
|
||||
|
|
@ -226,16 +197,11 @@ The object owner can optionally share objects with others by creating a presigne
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/urldownv2-v3.png" alt="aws s3 signed download" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/urldownv2-v3.png" alt="aws s3 signed download" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
|
||||
### Signed url for upload
|
||||
### Signed URL for upload
|
||||
|
||||
The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions.
|
||||
|
||||
|
|
@ -257,6 +223,4 @@ The presigned URLs are useful if you want your user/customer to be able to uploa
|
|||
|
||||
:::info
|
||||
We built an app to view and upload files to AWS S3 buckets. Check out the complete tutorial **[here](https://blog.tooljet.com/build-an-aws-s3-broswer-with-tooljet/)**.
|
||||
:::
|
||||
|
||||
</div>
|
||||
:::
|
||||
|
|
@ -2,7 +2,6 @@
|
|||
id: airtable
|
||||
title: Airtable
|
||||
---
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
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)**.
|
||||
|
||||
|
|
@ -16,9 +15,7 @@ ToolJet can connect to your **Airtable** account to read and write data. **Perso
|
|||
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'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Supported Operations
|
||||
|
||||
|
|
@ -30,7 +27,7 @@ Airtable API has a rate limit, and at the time of writing this documentation, th
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
### List records
|
||||
|
||||
|
|
@ -39,19 +36,16 @@ This operation returns a list of records from the specified table.
|
|||
#### Required parameters:
|
||||
|
||||
- **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.
|
||||
|
||||
- **Filter by formula:** This parameter will only return records that satisfy the formula. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error!, the record will be included in the result. e.g. `Name = 'John'`
|
||||
|
||||
- **Fields:** The fields you want to retrieve. If you don't specify the fields, all fields will be returned. e.g. `["Name", "Email", "Survey Response"]`
|
||||
|
||||
<br/>
|
||||
<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/list-records-v2.png" alt="Airtable List Records Query" />
|
||||
</div>
|
||||
|
|
@ -64,24 +58,24 @@ Example response from Airtable:
|
|||
{
|
||||
"id": "recu9xMnUdr2n2cw8",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dsfdsf"
|
||||
"Notes": "Meeting to discuss project details",
|
||||
"Name": "John Doe"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
},
|
||||
{
|
||||
"id": "recyIdR7bVdQvmKXa",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dfds"
|
||||
"Notes": "Follow-up call regarding contract",
|
||||
"Name": "Jane Smith"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
},
|
||||
{
|
||||
"id": "recAOzdIHaRpvRaGE",
|
||||
"fields": {
|
||||
"Notes": "sdfsdfsd",
|
||||
"Name": "sdfdsf"
|
||||
"Notes": "Client feedback review meeting",
|
||||
"Name": "Alice Johnson"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
}
|
||||
|
|
@ -92,18 +86,14 @@ 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 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 retrieve.
|
||||
|
||||
<br/>
|
||||
<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/retrieve-record-v2.png" alt="Airtable Retrieve Record Query" />
|
||||
</div>
|
||||
|
|
@ -115,27 +105,21 @@ Example response from Airtable:
|
|||
{
|
||||
"id": "recu9xMnUdr2n2cw8",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dsfdsf"
|
||||
"Notes": "Discuss project timeline",
|
||||
"Name": "Michael Scott"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Create record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to create the record.
|
||||
|
||||
- **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.
|
||||
|
||||
<br/>
|
||||
<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/create-record-v2.png" alt="Airtable Create Record Query" />
|
||||
</div>
|
||||
|
|
@ -169,22 +153,15 @@ Query returns the following response when the record is created successfully:
|
|||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Update record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to update the record.
|
||||
|
||||
- **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.
|
||||
|
||||
<br/>
|
||||
<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/update-record-v2.png" alt="Airtable Update Record Query" />
|
||||
</div>
|
||||
|
|
@ -215,20 +192,14 @@ Query returns the following response when the record is updated successfully:
|
|||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Delete record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to delete the record.
|
||||
|
||||
- **Record ID**: The ID of the record you want to delete.
|
||||
|
||||
<br/>
|
||||
<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/delete-record-v2.png" alt="Airtable Delete Record Query" />
|
||||
</div>
|
||||
|
|
@ -240,5 +211,4 @@ Query returns the following response when the record is deleted successfully:
|
|||
deleted: true
|
||||
id: "recIKsyZgqI4zoqS7"
|
||||
}
|
||||
```
|
||||
</div>
|
||||
```
|
||||
|
|
@ -3,13 +3,9 @@ id: amazonses
|
|||
title: Amazon SES
|
||||
---
|
||||
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
ToolJet can connect to your Amazon SES account to send emails.
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Connection
|
||||
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.
|
||||
|
|
@ -32,17 +28,16 @@ Click on the **Save** button to save the data source.
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Supported operations
|
||||
1. Email service
|
||||
|
||||
### Email service
|
||||
Required parameters:
|
||||
- Send email to
|
||||
- Send email from
|
||||
- Subject
|
||||
- Body as text
|
||||
- **Send email to**
|
||||
- **Send email from**
|
||||
- **Subject**
|
||||
- **Body as text**
|
||||
|
||||
|
||||
Optional parameters:
|
||||
|
|
|
|||
|
|
@ -2,17 +2,14 @@
|
|||
id: s3
|
||||
title: Amazon S3
|
||||
---
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
ToolJet can connect to **Amazon S3** buckets and perform various operation on them.
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the Amazon S3 data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard.
|
||||
To establish a connection with the **Amazon S3** data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard.
|
||||
|
||||
ToolJet supports connecting to AWS S3 using **IAM Access Keys**, **AWS Instance Credentials** or **AWS ARN Role**.
|
||||
|
||||
|
|
@ -52,7 +49,7 @@ You can now connect to **[different S3 Hosts using custom endpoints](/docs/how-t
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Querying AWS S3
|
||||
|
||||
|
|
@ -72,7 +69,7 @@ Query results can be transformed using transformations. Read our [transformation
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Query operations
|
||||
|
||||
|
|
@ -88,8 +85,6 @@ You can create query for AWS S3 data source to perform several actions such as:
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Create a new bucket
|
||||
|
||||
You can create a new bucket in your S3 by using this operation.
|
||||
|
|
@ -104,10 +99,6 @@ You can create a new bucket in your S3 by using this operation.
|
|||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Read object
|
||||
|
||||
You can read an object in a bucket by using this operation.
|
||||
|
|
@ -119,13 +110,9 @@ You can read an object in a bucket by using this operation.
|
|||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/readv2-v3.png" alt="aws s3 read object" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/readv2-v3.png" alt="aws s3 read object" />
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Upload object
|
||||
|
||||
You can use this operation to upload objects(files) to your S3 bucket.
|
||||
|
|
@ -139,13 +126,9 @@ You can use this operation to upload objects(files) to your S3 bucket.
|
|||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/uplobjv2-v3.png" alt="aws s3 upload"/>
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/uplobjv2-v3.png" alt="aws s3 upload"/>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Remove object
|
||||
|
||||
You can use this operation to remove an object from your S3 bucket.
|
||||
|
|
@ -157,27 +140,19 @@ You can use this operation to remove an object from your S3 bucket.
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/removeobject.png" alt="Create a new bucket - S3 operation" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/removeobject.png" alt="Create a new bucket - S3 operation" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### List buckets
|
||||
|
||||
This operation will list all the buckets in your S3. This does not require any parameter.
|
||||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/listbucketsv2-v3.png" alt="aws s3 bucket" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/listbucketsv2-v3.png" alt="aws s3 bucket" />
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### List objects in a bucket
|
||||
|
||||
This operation will fetch the list of all the files in your bucket. It requires the following parameters:
|
||||
|
|
@ -205,15 +180,11 @@ The results will continue from where the last listing finished.
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/listobjectsv2-v3.png" alt="aws s3 list object" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/listobjectsv2-v3.png" alt="aws s3 list object" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Signed url for download
|
||||
### Signed URL for download
|
||||
|
||||
The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects.
|
||||
|
||||
|
|
@ -226,16 +197,11 @@ The object owner can optionally share objects with others by creating a presigne
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/urldownv2-v3.png" alt="aws s3 signed download" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/urldownv2-v3.png" alt="aws s3 signed download" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
|
||||
### Signed url for upload
|
||||
### Signed URL for upload
|
||||
|
||||
The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions.
|
||||
|
||||
|
|
@ -257,6 +223,4 @@ The presigned URLs are useful if you want your user/customer to be able to uploa
|
|||
|
||||
:::info
|
||||
We built an app to view and upload files to AWS S3 buckets. Check out the complete tutorial **[here](https://blog.tooljet.com/build-an-aws-s3-broswer-with-tooljet/)**.
|
||||
:::
|
||||
|
||||
</div>
|
||||
:::
|
||||
|
|
@ -2,7 +2,6 @@
|
|||
id: airtable
|
||||
title: Airtable
|
||||
---
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
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)**.
|
||||
|
||||
|
|
@ -16,9 +15,7 @@ ToolJet can connect to your **Airtable** account to read and write data. **Perso
|
|||
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'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Supported Operations
|
||||
|
||||
|
|
@ -30,7 +27,7 @@ Airtable API has a rate limit, and at the time of writing this documentation, th
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
### List records
|
||||
|
||||
|
|
@ -39,19 +36,16 @@ This operation returns a list of records from the specified table.
|
|||
#### Required parameters:
|
||||
|
||||
- **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.
|
||||
|
||||
- **Filter by formula:** This parameter will only return records that satisfy the formula. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error!, the record will be included in the result. e.g. `Name = 'John'`
|
||||
|
||||
- **Fields:** The fields you want to retrieve. If you don't specify the fields, all fields will be returned. e.g. `["Name", "Email", "Survey Response"]`
|
||||
|
||||
<br/>
|
||||
<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/list-records-v2.png" alt="Airtable List Records Query" />
|
||||
</div>
|
||||
|
|
@ -64,24 +58,24 @@ Example response from Airtable:
|
|||
{
|
||||
"id": "recu9xMnUdr2n2cw8",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dsfdsf"
|
||||
"Notes": "Meeting to discuss project details",
|
||||
"Name": "John Doe"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
},
|
||||
{
|
||||
"id": "recyIdR7bVdQvmKXa",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dfds"
|
||||
"Notes": "Follow-up call regarding contract",
|
||||
"Name": "Jane Smith"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
},
|
||||
{
|
||||
"id": "recAOzdIHaRpvRaGE",
|
||||
"fields": {
|
||||
"Notes": "sdfsdfsd",
|
||||
"Name": "sdfdsf"
|
||||
"Notes": "Client feedback review meeting",
|
||||
"Name": "Alice Johnson"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
}
|
||||
|
|
@ -92,18 +86,14 @@ 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 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 retrieve.
|
||||
|
||||
<br/>
|
||||
<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/retrieve-record-v2.png" alt="Airtable Retrieve Record Query" />
|
||||
</div>
|
||||
|
|
@ -115,27 +105,21 @@ Example response from Airtable:
|
|||
{
|
||||
"id": "recu9xMnUdr2n2cw8",
|
||||
"fields": {
|
||||
"Notes": "sdfdsf",
|
||||
"Name": "dsfdsf"
|
||||
"Notes": "Discuss project timeline",
|
||||
"Name": "Michael Scott"
|
||||
},
|
||||
"createdTime": "2021-05-12T14:30:33.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Create record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to create the record.
|
||||
|
||||
- **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.
|
||||
|
||||
<br/>
|
||||
<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/create-record-v2.png" alt="Airtable Create Record Query" />
|
||||
</div>
|
||||
|
|
@ -169,22 +153,15 @@ Query returns the following response when the record is created successfully:
|
|||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Update record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to update the record.
|
||||
|
||||
- **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.
|
||||
|
||||
<br/>
|
||||
<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/update-record-v2.png" alt="Airtable Update Record Query" />
|
||||
</div>
|
||||
|
|
@ -215,20 +192,14 @@ Query returns the following response when the record is updated successfully:
|
|||
}
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Delete record
|
||||
|
||||
#### Required parameters:
|
||||
|
||||
- **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 where you want to delete the record.
|
||||
|
||||
- **Record ID**: The ID of the record you want to delete.
|
||||
|
||||
<br/>
|
||||
<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/delete-record-v2.png" alt="Airtable Delete Record Query" />
|
||||
</div>
|
||||
|
|
@ -240,5 +211,4 @@ Query returns the following response when the record is deleted successfully:
|
|||
deleted: true
|
||||
id: "recIKsyZgqI4zoqS7"
|
||||
}
|
||||
```
|
||||
</div>
|
||||
```
|
||||
|
|
@ -3,13 +3,9 @@ id: amazonses
|
|||
title: Amazon SES
|
||||
---
|
||||
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
ToolJet can connect to your Amazon SES account to send emails.
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Connection
|
||||
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.
|
||||
|
|
@ -32,17 +28,16 @@ Click on the **Save** button to save the data source.
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Supported operations
|
||||
1. Email service
|
||||
|
||||
### Email service
|
||||
Required parameters:
|
||||
- Send email to
|
||||
- Send email from
|
||||
- Subject
|
||||
- Body as text
|
||||
- **Send email to**
|
||||
- **Send email from**
|
||||
- **Subject**
|
||||
- **Body as text**
|
||||
|
||||
|
||||
Optional parameters:
|
||||
|
|
|
|||
|
|
@ -2,17 +2,14 @@
|
|||
id: s3
|
||||
title: Amazon S3
|
||||
---
|
||||
<div style={{paddingBottom:'24px'}}>
|
||||
|
||||
ToolJet can connect to **Amazon S3** buckets and perform various operation on them.
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Connection
|
||||
|
||||
To establish a connection with the Amazon S3 data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard.
|
||||
To establish a connection with the **Amazon S3** data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](/docs/data-sources/overview/)** page from the ToolJet dashboard.
|
||||
|
||||
ToolJet supports connecting to AWS S3 using **IAM Access Keys**, **AWS Instance Credentials** or **AWS ARN Role**.
|
||||
|
||||
|
|
@ -52,7 +49,7 @@ You can now connect to **[different S3 Hosts using custom endpoints](/docs/how-t
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Querying AWS S3
|
||||
|
||||
|
|
@ -72,7 +69,7 @@ Query results can be transformed using transformations. Read our [transformation
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Query operations
|
||||
|
||||
|
|
@ -88,8 +85,6 @@ You can create query for AWS S3 data source to perform several actions such as:
|
|||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Create a new bucket
|
||||
|
||||
You can create a new bucket in your S3 by using this operation.
|
||||
|
|
@ -104,10 +99,6 @@ You can create a new bucket in your S3 by using this operation.
|
|||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Read object
|
||||
|
||||
You can read an object in a bucket by using this operation.
|
||||
|
|
@ -119,13 +110,9 @@ You can read an object in a bucket by using this operation.
|
|||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/readv2-v3.png" alt="aws s3 read object" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/readv2-v3.png" alt="aws s3 read object" />
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Upload object
|
||||
|
||||
You can use this operation to upload objects(files) to your S3 bucket.
|
||||
|
|
@ -139,13 +126,9 @@ You can use this operation to upload objects(files) to your S3 bucket.
|
|||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/uplobjv2-v3.png" alt="aws s3 upload"/>
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/uplobjv2-v3.png" alt="aws s3 upload"/>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Remove object
|
||||
|
||||
You can use this operation to remove an object from your S3 bucket.
|
||||
|
|
@ -157,27 +140,19 @@ You can use this operation to remove an object from your S3 bucket.
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/removeobject.png" alt="Create a new bucket - S3 operation" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/removeobject.png" alt="Create a new bucket - S3 operation" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### List buckets
|
||||
|
||||
This operation will list all the buckets in your S3. This does not require any parameter.
|
||||
|
||||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/listbucketsv2-v3.png" alt="aws s3 bucket" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/listbucketsv2-v3.png" alt="aws s3 bucket" />
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### List objects in a bucket
|
||||
|
||||
This operation will fetch the list of all the files in your bucket. It requires the following parameters:
|
||||
|
|
@ -205,15 +180,11 @@ The results will continue from where the last listing finished.
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/listobjectsv2-v3.png" alt="aws s3 list object" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/listobjectsv2-v3.png" alt="aws s3 list object" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### Signed url for download
|
||||
### Signed URL for download
|
||||
|
||||
The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects.
|
||||
|
||||
|
|
@ -226,16 +197,11 @@ The object owner can optionally share objects with others by creating a presigne
|
|||
|
||||
<div style={{textAlign: 'left'}}>
|
||||
|
||||
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/aws-s3/urldownv2-v3.png" alt="aws s3 signed download" />
|
||||
<img style={{ border:'0'}} className="screenshot-full" src="/img/datasource-reference/aws-s3/urldownv2-v3.png" alt="aws s3 signed download" />
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
|
||||
### Signed url for upload
|
||||
### Signed URL for upload
|
||||
|
||||
The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions.
|
||||
|
||||
|
|
@ -257,6 +223,4 @@ The presigned URLs are useful if you want your user/customer to be able to uploa
|
|||
|
||||
:::info
|
||||
We built an app to view and upload files to AWS S3 buckets. Check out the complete tutorial **[here](https://blog.tooljet.com/build-an-aws-s3-broswer-with-tooljet/)**.
|
||||
:::
|
||||
|
||||
</div>
|
||||
:::
|
||||
Loading…
Reference in a new issue