🚸 Rename "webhook" block to "HTTP request"
This commit is contained in:
Baptiste Arnaud
@ -1,34 +1,16 @@
|
||||
---
|
||||
title: Webhook / API Request
|
||||
title: HTTP Request
|
||||
---
|
||||
|
||||
import { LoomVideo } from '/snippets/loom-video.mdx'
|
||||
|
||||
The Webhook block allows you to either:
|
||||
|
||||
- Call a Webhook URL of a 3rd party service to send information from the bot.
|
||||
- Make an API request to a 3rd party service to fetch information and use it in the bot.
|
||||
|
||||
## Call a Webhook URL
|
||||
|
||||
Your 3rd party service (Make.com, Zapier, etc) is giving you a Webhook URL.
|
||||
|
||||
You only have to paste this URL in the Webhook block and click on "Test the request". By default the 3rd party service will receive a snapshot of what the bot could send.
|
||||
|
||||
<Frame>
|
||||
<img
|
||||
src="/images/blocks/integrations/webhook/simple-post.png"
|
||||
alt="Simple Webhook POST"
|
||||
/>
|
||||
</Frame>
|
||||
|
||||
You can also decide to customize the request sent to the 3rd party service.
|
||||
The HTTP Request block allows you to send an HTTP request to a 3rd party service. This is useful to send information from the bot to another service or to fetch information from another service and use it in the bot.
|
||||
|
||||
## Make an API request and fetch data
|
||||
|
||||
This gets more technical as you'll need to know more about HTTP request parameters.
|
||||
|
||||
Lots of services offer an API. They also, most likely have an API documentation. Depending on the parameters you are giving the Webhook block, it should return different info from the 3rd party service.
|
||||
Lots of services offer an API. They also, most likely have an API documentation. Depending on the parameters you are giving the HTTP request block, it should return different info from the 3rd party service.
|
||||
|
||||
## Custom body
|
||||
|
||||
@ -43,9 +25,9 @@ You can set a custom body with your collected variables. Here is a working examp
|
||||
|
||||
### Example with a dummy API: CREATE and GET
|
||||
|
||||
This video provides a step-by-step guide to successfully configure webhook blocks in Typebot.
|
||||
This video provides a step-by-step guide to successfully configure HTTP request blocks in Typebot.
|
||||
|
||||
I demonstrate how to configure the webhook block, including the URL, method, and custom body. I also show you how to test the webhook call and save the newly created employee ID. Finally, I explain how to implement the find employee by ID endpoint and map the employee name to a variable.
|
||||
I demonstrate how to configure the HTTP request block, including the URL, method, and custom body. I also show you how to test the request and save the newly created employee ID. Finally, I explain how to implement the find employee by ID endpoint and map the employee name to a variable.
|
||||
|
||||
<LoomVideo id="d9aef6a37e0c43759b31be7d69c4dd6d" />
|
||||
|
||||
@ -92,6 +74,21 @@ Possibilities are endless when it comes to API calls, you can litteraly call any
|
||||
|
||||
Feel free to ask the [community](https://typebot.io/discord) for help if you struggle setting up a Webhook block.
|
||||
|
||||
## Call a Webhook URL
|
||||
|
||||
Your 3rd party service (Make.com, Zapier, etc) is giving you a Webhook URL.
|
||||
|
||||
You only have to paste this URL in the Webhook block and click on "Test the request". By default the 3rd party service will receive a snapshot of what the bot could send.
|
||||
|
||||
<Frame>
|
||||
<img
|
||||
src="/images/blocks/integrations/webhook/simple-post.png"
|
||||
alt="Simple Webhook POST"
|
||||
/>
|
||||
</Frame>
|
||||
|
||||
You can also decide to customize the request sent to the 3rd party service.
|
||||
|
||||
## Timeout
|
||||
|
||||
By default, the Webhook block will wait 10 seconds for the 3rd party service to respond. If it doesn't respond in time, the block will fail. You can customize this timeout value in the "Advanced params" section of your Webhook block settings.
|
||||
|
||||
@ -1977,7 +1977,8 @@
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Webhook"
|
||||
]
|
||||
],
|
||||
"description": "Legacy name for HTTP Request block"
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
@ -6372,7 +6373,8 @@
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Webhook"
|
||||
]
|
||||
],
|
||||
"description": "Legacy name for HTTP Request block"
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
@ -9818,7 +9820,8 @@
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Webhook"
|
||||
]
|
||||
],
|
||||
"description": "Legacy name for HTTP Request block"
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
@ -18269,7 +18272,8 @@
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Webhook"
|
||||
]
|
||||
],
|
||||
"description": "Legacy name for HTTP Request block"
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
@ -21840,7 +21844,8 @@
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Webhook"
|
||||
]
|
||||
],
|
||||
"description": "Legacy name for HTTP Request block"
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
@ -24660,7 +24665,8 @@
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Webhook"
|
||||
]
|
||||
],
|
||||
"description": "Legacy name for HTTP Request block"
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
|
||||
@ -5044,7 +5044,8 @@
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Webhook"
|
||||
]
|
||||
],
|
||||
"description": "Legacy name for HTTP Request block"
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
@ -8791,7 +8792,8 @@
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Webhook"
|
||||
]
|
||||
],
|
||||
"description": "Legacy name for HTTP Request block"
|
||||
},
|
||||
"options": {
|
||||
"type": "object",
|
||||
|
||||
Reference in New Issue
Block a user