Skip to content

Add connection setup documentation for some components #2858

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions docs/content/docs/reference/components/acumbamail.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -190,3 +190,16 @@ If this component doesn't have the action you need, you can use **Custom Action*

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

<hr />

# Additional instructions

## Connection Setup

1. Go to https://acumbamail.com/apidoc/.
2. Log in to your account.
3. Copy the auth token. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/mVotYQrVYC6y0NA3uTZf?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
16 changes: 16 additions & 0 deletions docs/content/docs/reference/components/bamboohr.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,19 @@ Type: STRING
<hr />


<hr />

# Additional instructions

## Connection Setup

1. Login to the dashboard at https://app.bamboohr.com/login/.
2. Click on My Account.
3. Click on API Keys.
4. Click Add New Key.
5. Name new API key and click Generate Key.
6. Copy the API key and click Done. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/V3Fd5SWAOezyTktpFiwX?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
14 changes: 14 additions & 0 deletions docs/content/docs/reference/components/bolna.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,17 @@ The output for this action is dynamic and may vary depending on the input parame
<hr />


<hr />

# Additional instructions

## Connection Setup

1. Login to the dashboard at https://platform.bolna.ai.
2. Navigate to Developers tab from the left menu bar after login.
3. Click the button Create a new API Key to generate a key.
4. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/z1FIORugGHA7hrd5hxXY?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
17 changes: 17 additions & 0 deletions docs/content/docs/reference/components/brevo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -211,3 +211,20 @@ The output for this action is dynamic and may vary depending on the input parame
<hr />


<hr />

# Additional instructions

## Connection Setup

1. Go to https://www.brevo.com/.
2. Log in to your account.
3. Click on company/organization name dropdown menu.
4. Click on SMTP & API.
5. Click on API keys.
6. Click on Generate a new API key and name it.
7. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/XwCeceuQfSdZFVrg5XZy?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
16 changes: 16 additions & 0 deletions docs/content/docs/reference/components/coda.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -349,3 +349,19 @@ If this component doesn't have the action you need, you can use **Custom Action*

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

<hr />

# Additional instructions

## Connection Setup

1. Login to the dashboard at https://coda.io/signin.
2. Click on your account.
3. Click on Account Settings.
4. Scroll to API Settings and click Generate API token.
5. Give your token a name and click Generate API token.
6. Copy the API token. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/LoU0lV4QiDN6CgNDTtPY?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
17 changes: 17 additions & 0 deletions docs/content/docs/reference/components/google-meet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -203,3 +203,20 @@ Type: OBJECT



<hr />

# Additional instructions

## Connection Setup

[Setting up OAuth2](https://support.google.com/googleapi/answer/6158849?hl=en)

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/fec74020-26bb-43dd-814c-f8b907f6f45b?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowfullscreen frameborder="0"></iframe>
</div>

Turning on Meet API
<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/1CkDQzRt6lbwhSWkjhQu?type=1&controls=on" width="100%" height="100%" style={{ position: 'absolute', inset: 0 }} allowfullscreen frameborder="0"></iframe>
</div>

18 changes: 18 additions & 0 deletions docs/content/docs/reference/components/klaviyo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -372,3 +372,21 @@ If this component doesn't have the action you need, you can use **Custom Action*

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

<hr />

# Additional instructions

## Connection Setup

1. Login to the dashboard at https://www.klaviyo.com/login?next=/account.
2. Click on your account.
3. Click on Settings.
4. Click on API keys.
5. Under the Private API Keys section, select Create Private API Key.
6. Name your API key and select Full Access Key.
7. Click Create.
8. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/wgokkQZJMgzfu6z25DJW?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
18 changes: 18 additions & 0 deletions docs/content/docs/reference/components/linear.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -555,3 +555,21 @@ Type: OBJECT
<hr />


<hr />

# Additional instructions

## Connection Setup

1. Login to the dashboard at https://linear.app/login.
2. You need to create a new OAuth2 Application to get credentials. First click on your profile.
3. Click on Settings.
4. Under Administration section, choose API.
5. Click on New OAuth application.
6. Fill information and enable Public.
7. Enable Webhooks and fill information. Then click Create.
8. Copy the Client ID and Client secret. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/WxAFGHjl0yfpptJdJLNU?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
14 changes: 14 additions & 0 deletions docs/content/docs/reference/components/mixpanel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,17 @@ Type: OBJECT



<hr />

# Additional instructions

## Connection Setup

1. Login to the dashboard at https://eu.mixpanel.com/login/.
2. Click on Settings.
3. Select Settings and then click on Project Settings.
4. Under Access Keys section, copy the Project Token. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/mZ86S7nxlbxJX8afuZXQ?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
12 changes: 12 additions & 0 deletions docs/content/docs/reference/components/scrape-graph-ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -210,3 +210,15 @@ Type: OBJECT



<hr />

# Additional instructions

## Connection Setup

1. Login to the dashboard at https://dashboard.scrapegraphai.com/login.
2. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/sfm38npUXm3cFkg5AaNp?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
14 changes: 14 additions & 0 deletions docs/content/docs/reference/components/tavily.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -178,3 +178,17 @@ If this component doesn't have the action you need, you can use **Custom Action*

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

<hr />

# Additional instructions

## Connection Setup

1. Login to the dashboard at https://www.tavily.com/.
2. You can use default API key. To create new API key, click on "+" sign.
3. Name your key and click Create.
4. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/SoAkwnI4qTGu8Kqt1BS1?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Connection Setup

1. Go to https://acumbamail.com/apidoc/.
2. Log in to your account.
3. Copy the auth token. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/mVotYQrVYC6y0NA3uTZf?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Connection Setup

1. Login to the dashboard at https://app.bamboohr.com/login/.
2. Click on My Account.
3. Click on API Keys.
4. Click Add New Key.
5. Name new API key and click Generate Key.
6. Copy the API key and click Done. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/V3Fd5SWAOezyTktpFiwX?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
10 changes: 10 additions & 0 deletions server/libs/modules/components/bolna/src/main/resources/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Connection Setup

1. Login to the dashboard at https://platform.bolna.ai.
2. Navigate to Developers tab from the left menu bar after login.
3. Click the button Create a new API Key to generate a key.
4. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/z1FIORugGHA7hrd5hxXY?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
13 changes: 13 additions & 0 deletions server/libs/modules/components/brevo/src/main/resources/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Connection Setup

1. Go to https://www.brevo.com/.
2. Log in to your account.
3. Click on company/organization name dropdown menu.
4. Click on SMTP & API.
5. Click on API keys.
6. Click on Generate a new API key and name it.
7. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/XwCeceuQfSdZFVrg5XZy?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
12 changes: 12 additions & 0 deletions server/libs/modules/components/coda/src/main/resources/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Connection Setup

1. Login to the dashboard at https://coda.io/signin.
2. Click on your account.
3. Click on Account Settings.
4. Scroll to API Settings and click Generate API token.
5. Give your token a name and click Generate API token.
6. Copy the API token. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/LoU0lV4QiDN6CgNDTtPY?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Connection Setup

[Setting up OAuth2](https://support.google.com/googleapi/answer/6158849?hl=en)

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/fec74020-26bb-43dd-814c-f8b907f6f45b?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowfullscreen frameborder="0"></iframe>
</div>

Turning on Meet API
<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/1CkDQzRt6lbwhSWkjhQu?type=1&controls=on" width="100%" height="100%" style={{ position: 'absolute', inset: 0 }} allowfullscreen frameborder="0"></iframe>
</div>

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Connection Setup

1. Login to the dashboard at https://www.klaviyo.com/login?next=/account.
2. Click on your account.
3. Click on Settings.
4. Click on API keys.
5. Under the Private API Keys section, select Create Private API Key.
6. Name your API key and select Full Access Key.
7. Click Create.
8. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/wgokkQZJMgzfu6z25DJW?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Connection Setup

1. Login to the dashboard at https://linear.app/login.
2. You need to create a new OAuth2 Application to get credentials. First click on your profile.
3. Click on Settings.
4. Under Administration section, choose API.
5. Click on New OAuth application.
6. Fill information and enable Public.
7. Enable Webhooks and fill information. Then click Create.
8. Copy the Client ID and Client secret. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/WxAFGHjl0yfpptJdJLNU?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Connection Setup

1. Login to the dashboard at https://eu.mixpanel.com/login/.
2. Click on Settings.
3. Select Settings and then click on Project Settings.
4. Under Access Keys section, copy the Project Token. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/mZ86S7nxlbxJX8afuZXQ?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Connection Setup

1. Login to the dashboard at https://dashboard.scrapegraphai.com/login.
2. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/sfm38npUXm3cFkg5AaNp?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Connection Setup

1. Login to the dashboard at https://www.tavily.com/.
2. You can use default API key. To create new API key, click on "+" sign.
3. Name your key and click Create.
4. Copy the API key. Use these credentials to create a connection in ByteChef.

<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
<iframe src="https://www.guidejar.com/embed/SoAkwnI4qTGu8Kqt1BS1?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowfullscreen frameborder="0"></iframe>
</div>