blsmedia/bot
2
0
Fork 0
Code Activity

docs(api): 📝 Simplified API endpoints

Browse Source
This commit is contained in:
Baptiste Arnaud
2022-04-15 07:49:27 -07:00
parent 281fddc8ef
commit 29254f675c
8 changed files with 376 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
apps/docs/docs/api.mdx
View File

@@ -45,54 +45,42 @@ curl -i -X GET https://typebot.io/api/typebots \
}
```
### <Tag color="green">GET</Tag> /api/typebots/<Tag>typebotId</Tag>/webhookSteps
### <Tag color="green">GET</Tag> /api/typebots/<Tag>typebotId</Tag>/webhookBlocks
List webhook steps in a typebot. These are the steps you can, later on, register your Webhook URL:
List webhook blocks in a typebot. These are the blocks you can register a Webhook URL:
```bash title="Try it yourself"
curl -i -X GET https://typebot.io/api/typebots/$TYPEBOT_ID/webhookSteps \
curl -i -X GET https://typebot.io/api/typebots/$TYPEBOT_ID/webhookBlocks \
-H 'Authorization: Bearer ${TOKEN}'
```
```json title="Response 200 OK"
{
"steps": [
"blocks": [
{
"blockId": "blockId",
"id": "stepId",
"name": "Block #2 > stepId"
"name": "Group #2 > blockId",
"url": "https://my-webhook.com/webhook"
}
]
}
```
### <Tag color="green">GET</Tag> /api/typebots/<Tag>typebotId</Tag>/blocks/<Tag>blockId</Tag>/steps/<Tag>stepId</Tag>/sampleResult
### <Tag color="green">GET</Tag> /api/typebots/<Tag>typebotId</Tag>/blocks/<Tag>blockId</Tag>/sampleResult
Get a sample of what the webhook body will look like when triggered
```bash title="Try it yourself"
curl -i -X GET https://typebot.io/api/typebots/$TYPEBOT_ID/blocks/$BLOCK_ID/steps/$STEP_ID/sampleResult \
curl -i -X GET https://typebot.io/api/typebots/$TYPEBOT_ID/blocks/$BLOCK_ID/sampleResult \
-H 'Authorization: Bearer ${TOKEN}'
```
```json title="Response 200 OK"
{
"steps": [
{
"blockId": "blockId",
"id": "stepId",
"name": "Block #2 > stepId"
}
]
}
```
### <Tag color="orange">POST</Tag> /api/typebots/<Tag>typebotId</Tag>/blocks/<Tag>blockId</Tag>/subscribeWebhook
### <Tag color="orange">POST</Tag> /api/typebots/<Tag>typebotId</Tag>/blocks/<Tag>blockId</Tag>/steps/<Tag>stepId</Tag>/subscribeWebhook
Subscribe the step to a specified webhook URL
Subscribe the block to a specified webhook URL
```bash title="Try it yourself"
curl -i -X POST https://typebot.io/api/typebots/$TYPEBOT_ID/webhookSteps \
curl -i -X POST https://typebot.io/api/typebots/$TYPEBOT_ID/blocks/$BLOCK_ID/subscribeWebhook \
-H 'Authorization: Bearer ${TOKEN}'\
--header 'Content-Type: application/json' \
--data '{"url": "https://domain.com/my-webhook"}'
@@ -114,12 +102,12 @@ The url you want to subscribe to.
<hr />
### <Tag color="orange">POST</Tag> /api/typebots/<Tag>typebotId</Tag>/blocks/<Tag>blockId</Tag>/steps/<Tag>stepId</Tag>/unsubscribeWebhook
### <Tag color="orange">POST</Tag> /api/typebots/<Tag>typebotId</Tag>/blocks/<Tag>blockId</Tag>/unsubscribeWebhook
Unsubscribe the current webhook on step
Unsubscribe the current webhook on block
```bash title="Try it yourself"
curl -i -X POST https://typebot.io/api/typebots/$TYPEBOT_ID/webhookSteps \
curl -i -X POST https://typebot.io/api/typebots/$TYPEBOT_ID/blocks/$BLOCK_ID/unsubscribeWebhook \
-H 'Authorization: Bearer ${TOKEN}'\
```

4
apps/docs/src/js/api-helpers.js
View File

@@ -1,5 +1,6 @@
// Taken from https://github.com/plausible/docs/blob/master/src/js/api-helpers.js 💙
import React from 'react'
import { useColorMode } from '@docusaurus/theme-common'
export const Required = () => (
<span
@@ -30,7 +31,8 @@ export const Optional = () => (
)
export const Tag = ({ children, color }) => {
let backgroundColor = '#CBD5E0'
const { isDarkTheme } = useColorMode()
let backgroundColor = isDarkTheme ? '#2d60b4' : '#CBD5E0'
switch (color) {
case 'green':
backgroundColor = '#68D391'