Create webhook source
curl --request POST \
--url https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"steps": [
{
"name": "<string>",
"order": 123,
"url": "<string>",
"method": "GET",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"extractions": [
{
"variableName": "<string>",
"jsonPath": "<string>",
"useAsContext": false
}
],
"fanOut": {
"sourcePath": "<string>",
"itemVariable": "item",
"rateLimit": {
"delayMs": 123
}
},
"retry": {
"maxAttempts": 0,
"initialDelayMs": 1000,
"maxDelayMs": 30000,
"backoffMultiplier": 2
},
"onError": "fail",
"timeoutMs": 123
}
],
"flowInputs": [
{
"name": "<string>",
"value": "<string>"
}
],
"url": "<string>",
"method": "<string>",
"headers": {},
"body": "<string>",
"auth": {},
"intervalMinutes": 123,
"timeoutMs": 123
}
'import requests
url = "https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks"
payload = {
"name": "<string>",
"steps": [
{
"name": "<string>",
"order": 123,
"url": "<string>",
"method": "GET",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"extractions": [
{
"variableName": "<string>",
"jsonPath": "<string>",
"useAsContext": False
}
],
"fanOut": {
"sourcePath": "<string>",
"itemVariable": "item",
"rateLimit": { "delayMs": 123 }
},
"retry": {
"maxAttempts": 0,
"initialDelayMs": 1000,
"maxDelayMs": 30000,
"backoffMultiplier": 2
},
"onError": "fail",
"timeoutMs": 123
}
],
"flowInputs": [
{
"name": "<string>",
"value": "<string>"
}
],
"url": "<string>",
"method": "<string>",
"headers": {},
"body": "<string>",
"auth": {},
"intervalMinutes": 123,
"timeoutMs": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
steps: [
{
name: '<string>',
order: 123,
url: '<string>',
method: 'GET',
headers: [{key: '<string>', value: '<string>'}],
body: JSON.stringify('<string>'),
extractions: [{variableName: '<string>', jsonPath: '<string>', useAsContext: false}],
fanOut: {sourcePath: '<string>', itemVariable: 'item', rateLimit: {delayMs: 123}},
retry: {maxAttempts: 0, initialDelayMs: 1000, maxDelayMs: 30000, backoffMultiplier: 2},
onError: 'fail',
timeoutMs: 123
}
],
flowInputs: [{name: '<string>', value: '<string>'}],
url: '<string>',
method: '<string>',
headers: {},
body: JSON.stringify('<string>'),
auth: {},
intervalMinutes: 123,
timeoutMs: 123
})
};
fetch('https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'steps' => [
[
'name' => '<string>',
'order' => 123,
'url' => '<string>',
'method' => 'GET',
'headers' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'body' => '<string>',
'extractions' => [
[
'variableName' => '<string>',
'jsonPath' => '<string>',
'useAsContext' => false
]
],
'fanOut' => [
'sourcePath' => '<string>',
'itemVariable' => 'item',
'rateLimit' => [
'delayMs' => 123
]
],
'retry' => [
'maxAttempts' => 0,
'initialDelayMs' => 1000,
'maxDelayMs' => 30000,
'backoffMultiplier' => 2
],
'onError' => 'fail',
'timeoutMs' => 123
]
],
'flowInputs' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'url' => '<string>',
'method' => '<string>',
'headers' => [
],
'body' => '<string>',
'auth' => [
],
'intervalMinutes' => 123,
'timeoutMs' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"name\": \"<string>\",\n \"order\": 123,\n \"url\": \"<string>\",\n \"method\": \"GET\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"extractions\": [\n {\n \"variableName\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"useAsContext\": false\n }\n ],\n \"fanOut\": {\n \"sourcePath\": \"<string>\",\n \"itemVariable\": \"item\",\n \"rateLimit\": {\n \"delayMs\": 123\n }\n },\n \"retry\": {\n \"maxAttempts\": 0,\n \"initialDelayMs\": 1000,\n \"maxDelayMs\": 30000,\n \"backoffMultiplier\": 2\n },\n \"onError\": \"fail\",\n \"timeoutMs\": 123\n }\n ],\n \"flowInputs\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"url\": \"<string>\",\n \"method\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\",\n \"auth\": {},\n \"intervalMinutes\": 123,\n \"timeoutMs\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"name\": \"<string>\",\n \"order\": 123,\n \"url\": \"<string>\",\n \"method\": \"GET\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"extractions\": [\n {\n \"variableName\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"useAsContext\": false\n }\n ],\n \"fanOut\": {\n \"sourcePath\": \"<string>\",\n \"itemVariable\": \"item\",\n \"rateLimit\": {\n \"delayMs\": 123\n }\n },\n \"retry\": {\n \"maxAttempts\": 0,\n \"initialDelayMs\": 1000,\n \"maxDelayMs\": 30000,\n \"backoffMultiplier\": 2\n },\n \"onError\": \"fail\",\n \"timeoutMs\": 123\n }\n ],\n \"flowInputs\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"url\": \"<string>\",\n \"method\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\",\n \"auth\": {},\n \"intervalMinutes\": 123,\n \"timeoutMs\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"name\": \"<string>\",\n \"order\": 123,\n \"url\": \"<string>\",\n \"method\": \"GET\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"extractions\": [\n {\n \"variableName\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"useAsContext\": false\n }\n ],\n \"fanOut\": {\n \"sourcePath\": \"<string>\",\n \"itemVariable\": \"item\",\n \"rateLimit\": {\n \"delayMs\": 123\n }\n },\n \"retry\": {\n \"maxAttempts\": 0,\n \"initialDelayMs\": 1000,\n \"maxDelayMs\": 30000,\n \"backoffMultiplier\": 2\n },\n \"onError\": \"fail\",\n \"timeoutMs\": 123\n }\n ],\n \"flowInputs\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"url\": \"<string>\",\n \"method\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\",\n \"auth\": {},\n \"intervalMinutes\": 123,\n \"timeoutMs\": 123\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"accountId": "<string>",
"knowledgeBaseId": "<string>",
"name": "<string>",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"steps": [
{
"name": "<string>",
"order": 123,
"url": "<string>",
"method": "GET",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"extractions": [
{
"variableName": "<string>",
"jsonPath": "<string>",
"useAsContext": false
}
],
"fanOut": {
"sourcePath": "<string>",
"itemVariable": "item",
"rateLimit": {
"delayMs": 123
}
},
"retry": {
"maxAttempts": 0,
"initialDelayMs": 1000,
"maxDelayMs": 30000,
"backoffMultiplier": 2
},
"onError": "fail",
"timeoutMs": 123
}
],
"flowInputs": [
{
"name": "<string>",
"value": "<string>"
}
],
"url": "<string>",
"method": "<string>",
"headers": {},
"body": "<string>",
"auth": {},
"intervalMinutes": 123,
"timeoutMs": 123,
"lastTriggeredAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}{
"error": "<string>"
}Knowledge Bases
Create Webhook Source
Creates a new webhook source for a knowledge base. A webhook source
defines how to fetch content from an external URL or execute a series
of steps to produce content. Requires either steps or url.
Requires knowledge:upload permission.
POST
/
api
/
knowledge-bases
/
{id}
/
webhooks
Create webhook source
curl --request POST \
--url https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"steps": [
{
"name": "<string>",
"order": 123,
"url": "<string>",
"method": "GET",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"extractions": [
{
"variableName": "<string>",
"jsonPath": "<string>",
"useAsContext": false
}
],
"fanOut": {
"sourcePath": "<string>",
"itemVariable": "item",
"rateLimit": {
"delayMs": 123
}
},
"retry": {
"maxAttempts": 0,
"initialDelayMs": 1000,
"maxDelayMs": 30000,
"backoffMultiplier": 2
},
"onError": "fail",
"timeoutMs": 123
}
],
"flowInputs": [
{
"name": "<string>",
"value": "<string>"
}
],
"url": "<string>",
"method": "<string>",
"headers": {},
"body": "<string>",
"auth": {},
"intervalMinutes": 123,
"timeoutMs": 123
}
'import requests
url = "https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks"
payload = {
"name": "<string>",
"steps": [
{
"name": "<string>",
"order": 123,
"url": "<string>",
"method": "GET",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"extractions": [
{
"variableName": "<string>",
"jsonPath": "<string>",
"useAsContext": False
}
],
"fanOut": {
"sourcePath": "<string>",
"itemVariable": "item",
"rateLimit": { "delayMs": 123 }
},
"retry": {
"maxAttempts": 0,
"initialDelayMs": 1000,
"maxDelayMs": 30000,
"backoffMultiplier": 2
},
"onError": "fail",
"timeoutMs": 123
}
],
"flowInputs": [
{
"name": "<string>",
"value": "<string>"
}
],
"url": "<string>",
"method": "<string>",
"headers": {},
"body": "<string>",
"auth": {},
"intervalMinutes": 123,
"timeoutMs": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
steps: [
{
name: '<string>',
order: 123,
url: '<string>',
method: 'GET',
headers: [{key: '<string>', value: '<string>'}],
body: JSON.stringify('<string>'),
extractions: [{variableName: '<string>', jsonPath: '<string>', useAsContext: false}],
fanOut: {sourcePath: '<string>', itemVariable: 'item', rateLimit: {delayMs: 123}},
retry: {maxAttempts: 0, initialDelayMs: 1000, maxDelayMs: 30000, backoffMultiplier: 2},
onError: 'fail',
timeoutMs: 123
}
],
flowInputs: [{name: '<string>', value: '<string>'}],
url: '<string>',
method: '<string>',
headers: {},
body: JSON.stringify('<string>'),
auth: {},
intervalMinutes: 123,
timeoutMs: 123
})
};
fetch('https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'steps' => [
[
'name' => '<string>',
'order' => 123,
'url' => '<string>',
'method' => 'GET',
'headers' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'body' => '<string>',
'extractions' => [
[
'variableName' => '<string>',
'jsonPath' => '<string>',
'useAsContext' => false
]
],
'fanOut' => [
'sourcePath' => '<string>',
'itemVariable' => 'item',
'rateLimit' => [
'delayMs' => 123
]
],
'retry' => [
'maxAttempts' => 0,
'initialDelayMs' => 1000,
'maxDelayMs' => 30000,
'backoffMultiplier' => 2
],
'onError' => 'fail',
'timeoutMs' => 123
]
],
'flowInputs' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'url' => '<string>',
'method' => '<string>',
'headers' => [
],
'body' => '<string>',
'auth' => [
],
'intervalMinutes' => 123,
'timeoutMs' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"name\": \"<string>\",\n \"order\": 123,\n \"url\": \"<string>\",\n \"method\": \"GET\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"extractions\": [\n {\n \"variableName\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"useAsContext\": false\n }\n ],\n \"fanOut\": {\n \"sourcePath\": \"<string>\",\n \"itemVariable\": \"item\",\n \"rateLimit\": {\n \"delayMs\": 123\n }\n },\n \"retry\": {\n \"maxAttempts\": 0,\n \"initialDelayMs\": 1000,\n \"maxDelayMs\": 30000,\n \"backoffMultiplier\": 2\n },\n \"onError\": \"fail\",\n \"timeoutMs\": 123\n }\n ],\n \"flowInputs\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"url\": \"<string>\",\n \"method\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\",\n \"auth\": {},\n \"intervalMinutes\": 123,\n \"timeoutMs\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"name\": \"<string>\",\n \"order\": 123,\n \"url\": \"<string>\",\n \"method\": \"GET\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"extractions\": [\n {\n \"variableName\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"useAsContext\": false\n }\n ],\n \"fanOut\": {\n \"sourcePath\": \"<string>\",\n \"itemVariable\": \"item\",\n \"rateLimit\": {\n \"delayMs\": 123\n }\n },\n \"retry\": {\n \"maxAttempts\": 0,\n \"initialDelayMs\": 1000,\n \"maxDelayMs\": 30000,\n \"backoffMultiplier\": 2\n },\n \"onError\": \"fail\",\n \"timeoutMs\": 123\n }\n ],\n \"flowInputs\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"url\": \"<string>\",\n \"method\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\",\n \"auth\": {},\n \"intervalMinutes\": 123,\n \"timeoutMs\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.naturalead.ai/api/knowledge-bases/{id}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"name\": \"<string>\",\n \"order\": 123,\n \"url\": \"<string>\",\n \"method\": \"GET\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"body\": \"<string>\",\n \"extractions\": [\n {\n \"variableName\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"useAsContext\": false\n }\n ],\n \"fanOut\": {\n \"sourcePath\": \"<string>\",\n \"itemVariable\": \"item\",\n \"rateLimit\": {\n \"delayMs\": 123\n }\n },\n \"retry\": {\n \"maxAttempts\": 0,\n \"initialDelayMs\": 1000,\n \"maxDelayMs\": 30000,\n \"backoffMultiplier\": 2\n },\n \"onError\": \"fail\",\n \"timeoutMs\": 123\n }\n ],\n \"flowInputs\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"url\": \"<string>\",\n \"method\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\",\n \"auth\": {},\n \"intervalMinutes\": 123,\n \"timeoutMs\": 123\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"accountId": "<string>",
"knowledgeBaseId": "<string>",
"name": "<string>",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"steps": [
{
"name": "<string>",
"order": 123,
"url": "<string>",
"method": "GET",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"body": "<string>",
"extractions": [
{
"variableName": "<string>",
"jsonPath": "<string>",
"useAsContext": false
}
],
"fanOut": {
"sourcePath": "<string>",
"itemVariable": "item",
"rateLimit": {
"delayMs": 123
}
},
"retry": {
"maxAttempts": 0,
"initialDelayMs": 1000,
"maxDelayMs": 30000,
"backoffMultiplier": 2
},
"onError": "fail",
"timeoutMs": 123
}
],
"flowInputs": [
{
"name": "<string>",
"value": "<string>"
}
],
"url": "<string>",
"method": "<string>",
"headers": {},
"body": "<string>",
"auth": {},
"intervalMinutes": 123,
"timeoutMs": 123,
"lastTriggeredAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer token using an API key (format nl_live_* or nl_test_*)
Path Parameters
Knowledge base ID
Body
application/json
Name of the webhook source
Ordered list of steps to execute
Show child attributes
Show child attributes
Input variables for the step flow
Show child attributes
Show child attributes
URL to fetch content from
HTTP method for the URL request
HTTP headers for the URL request
Show child attributes
Show child attributes
Request body for the URL request
Authentication configuration for the URL request
Polling interval in minutes
Request timeout in milliseconds
Response
Created webhook source
Unique identifier
Owning account ID
Parent knowledge base ID
Webhook source name
Whether the webhook source is active
Ordered list of execution steps
Show child attributes
Show child attributes
Input variables for the step flow
Show child attributes
Show child attributes
URL to fetch content from
HTTP method
HTTP headers
Show child attributes
Show child attributes
Request body
Authentication configuration
Polling interval in minutes
Request timeout in milliseconds
Timestamp of the last trigger