Overview of webhook parameters in Base automated workflows

Overview of webhook parameters in Base automated workflows

3 min read
I. Intro
This article explains how to use the "When webhook received" trigger in Base automation and provides a detailed look at webhook parameters and common error codes. For more information on using webhook triggers, see Use webhook triggers in automated workflows.
II. Description
Request headers and examples
Name
Type
Required
Description
Authorization
string
No
Bearer tokens must be sent to Base automation through request headers. Headers are formatted as follows (case sensitive):
--header 'Authorization: Bearer [true bearer token]'
Single quotation marks are mandatory in the actual headers. Square brackets ([ ]) are used to indicate variables and do not need to be included in the actual headers.
The header key is always "Authorization", and the value has a fixed prefix of "Bearer".
Note that there must be a space between the prefix "Bearer" and the actual bearer token.
Client-Token
string
No
In an idempotent header, the key is always "Client-Token", and the value is user-generated and normally the uuid.
A new request will be initiated if this value is empty. An idempotent update operation will be initiated if the value is not empty, and the same value can only trigger the operation once within 3 hours.
Below is a sample bearer token (the text in square brackets must be replaced with the actual variables to be used):
curl --location --request POST '[webhook address]' \
--header 'Authorization: Bearer [Bearer token]' \
--header 'Content-Type: application/json' \
--data-raw '{[request body]}'
Request body
Configure as needed. The format must comply with JSON requirements.
Response body and examples
A response body code that is not 0 indicates a failure.
If the code is not 0, check the error code and message in the error code table below to troubleshoot.
The following is an example of the response body when the webhook is correctly received:
{
"msg": "",
"data": { },
"code": 0
}
The following is an example of the response body when there is a webhook error:
{
"data": { },
"code": 800004509,
"msg": "webhook trigger workflow is disabled"
}
Error codes
If the webhook trigger produces an error, you will need to view the error details at the requester end and troubleshoot based on the error codes and text in the table below.
Error code
Error message
Cause
Solution
800005649
Bearer token rejected.
Bearer tokens are enabled but the workflow did not run, as the token carried by the HTTP request did not match the token needed by the automated workflow.
Check again and enter the token.
800005650
IP address not on allowlist.
The IP allowlist is enabled but the IP address that sent the request is not on the list.
Add the IP address in question to the allowlist or change the IP address and resend the request.
800005647
Request is too large.
Webhooks only accept HTTP requests up to 4 MB in size.
Reduce the size of the request.
800005646
HTTP node trapped in circular referencing loop, please edit the HTTP node's request address.
An automated workflow triggered by webhook is set to run an HTTP request but the URL for the HTTP request is the same as the webhook address for the workflow itself, causing the workflow to loop.
Edit the HTTP request URL so that it does not match the webhook address.
800005652
Too many requests, please try again later.
The webhook has received too many HTTP requests and has been throttled.
  • Each base can handle a maximum of 50 webhook trigger events per second.
  • Each automated workflow can handle a maximum of five webhook trigger events per second.
  • Each automated workflow that does not have bearer tokens enabled can handle a maximum of one webhook trigger event per second.
Try again later.
800006003
Non-compliant JSON data in the request body.
This generally happens when data structure settings are set to Send Sample Request. It means the received request body JSON schema is incorrectly formatted.
Check and correct the JSON schema in the request body, then retry.
III. Related
Written by: Lark Help Center
Updated on 2024-08-01
How satisfied are you with this content?
Thank you for your feedback!
Need more help? Please contact Support.
0
rangeDom