Create Typebot

Create Typebot

curl --request POST \
  --url https://{server-url}/typebot/create/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "enabled": true,
  "url": "<string>",
  "typebot": "<string>",
  "triggerType": "<string>",
  "triggerOperator": "<string>",
  "triggerValue": "<string>",
  "expire": 123,
  "keywordFinish": "<string>",
  "delayMessage": 123,
  "unknownMessage": "<string>",
  "listeningFromMe": true,
  "stopBotFromMe": true,
  "keepOpen": true,
  "debounceTime": 123
}
'

import requests

url = "https://{server-url}/typebot/create/{instance}"

payload = {
    "enabled": True,
    "url": "<string>",
    "typebot": "<string>",
    "triggerType": "<string>",
    "triggerOperator": "<string>",
    "triggerValue": "<string>",
    "expire": 123,
    "keywordFinish": "<string>",
    "delayMessage": 123,
    "unknownMessage": "<string>",
    "listeningFromMe": True,
    "stopBotFromMe": True,
    "keepOpen": True,
    "debounceTime": 123
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    url: '<string>',
    typebot: '<string>',
    triggerType: '<string>',
    triggerOperator: '<string>',
    triggerValue: '<string>',
    expire: 123,
    keywordFinish: '<string>',
    delayMessage: 123,
    unknownMessage: '<string>',
    listeningFromMe: true,
    stopBotFromMe: true,
    keepOpen: true,
    debounceTime: 123
  })
};

fetch('https://{server-url}/typebot/create/{instance}', 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://{server-url}/typebot/create/{instance}",
  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([
    'enabled' => true,
    'url' => '<string>',
    'typebot' => '<string>',
    'triggerType' => '<string>',
    'triggerOperator' => '<string>',
    'triggerValue' => '<string>',
    'expire' => 123,
    'keywordFinish' => '<string>',
    'delayMessage' => 123,
    'unknownMessage' => '<string>',
    'listeningFromMe' => true,
    'stopBotFromMe' => true,
    'keepOpen' => true,
    'debounceTime' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$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://{server-url}/typebot/create/{instance}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"typebot\": \"<string>\",\n  \"triggerType\": \"<string>\",\n  \"triggerOperator\": \"<string>\",\n  \"triggerValue\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	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://{server-url}/typebot/create/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"typebot\": \"<string>\",\n  \"triggerType\": \"<string>\",\n  \"triggerOperator\": \"<string>\",\n  \"triggerValue\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/typebot/create/{instance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"typebot\": \"<string>\",\n  \"triggerType\": \"<string>\",\n  \"triggerOperator\": \"<string>\",\n  \"triggerValue\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123\n}"

response = http.request(request)
puts response.read_body

This response has no body data.

POST

typebot

create

{instance}

Create Typebot

curl --request POST \
  --url https://{server-url}/typebot/create/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "enabled": true,
  "url": "<string>",
  "typebot": "<string>",
  "triggerType": "<string>",
  "triggerOperator": "<string>",
  "triggerValue": "<string>",
  "expire": 123,
  "keywordFinish": "<string>",
  "delayMessage": 123,
  "unknownMessage": "<string>",
  "listeningFromMe": true,
  "stopBotFromMe": true,
  "keepOpen": true,
  "debounceTime": 123
}
'

import requests

url = "https://{server-url}/typebot/create/{instance}"

payload = {
    "enabled": True,
    "url": "<string>",
    "typebot": "<string>",
    "triggerType": "<string>",
    "triggerOperator": "<string>",
    "triggerValue": "<string>",
    "expire": 123,
    "keywordFinish": "<string>",
    "delayMessage": 123,
    "unknownMessage": "<string>",
    "listeningFromMe": True,
    "stopBotFromMe": True,
    "keepOpen": True,
    "debounceTime": 123
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    url: '<string>',
    typebot: '<string>',
    triggerType: '<string>',
    triggerOperator: '<string>',
    triggerValue: '<string>',
    expire: 123,
    keywordFinish: '<string>',
    delayMessage: 123,
    unknownMessage: '<string>',
    listeningFromMe: true,
    stopBotFromMe: true,
    keepOpen: true,
    debounceTime: 123
  })
};

fetch('https://{server-url}/typebot/create/{instance}', 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://{server-url}/typebot/create/{instance}",
  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([
    'enabled' => true,
    'url' => '<string>',
    'typebot' => '<string>',
    'triggerType' => '<string>',
    'triggerOperator' => '<string>',
    'triggerValue' => '<string>',
    'expire' => 123,
    'keywordFinish' => '<string>',
    'delayMessage' => 123,
    'unknownMessage' => '<string>',
    'listeningFromMe' => true,
    'stopBotFromMe' => true,
    'keepOpen' => true,
    'debounceTime' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$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://{server-url}/typebot/create/{instance}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"typebot\": \"<string>\",\n  \"triggerType\": \"<string>\",\n  \"triggerOperator\": \"<string>\",\n  \"triggerValue\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	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://{server-url}/typebot/create/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"typebot\": \"<string>\",\n  \"triggerType\": \"<string>\",\n  \"triggerOperator\": \"<string>\",\n  \"triggerValue\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/typebot/create/{instance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"url\": \"<string>\",\n  \"typebot\": \"<string>\",\n  \"triggerType\": \"<string>\",\n  \"triggerOperator\": \"<string>\",\n  \"triggerValue\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123\n}"

response = http.request(request)
puts response.read_body

This response has no body data.

Authorizations

apikey

string

header

required

Your authorization key header

Path Parameters

instance

string

required

Name of the instance

Body

application/json

enabled

boolean

required

url

string

required

Typebot URL

typebot

string

required

Typebot name

triggerType

string

required

All or keyword

triggerOperator

string

required

Operator logic, ex: contains, equals, startsWith, endsWith, regex

triggerValue

string

required

All or keyword

expire

number

required

Time to expire session

keywordFinish

string

required

Keyword to finish session

delayMessage

number

required

Delay when the bot send message

unknownMessage

string

required

Unrecognized message

listeningFromMe

boolean

required

Marked as viewed

stopBotFromMe

boolean

required

Stop bot when I send message

keepOpen

boolean

required

Keep session open

debounceTime

number

required

Start typebot for your own messages

Response

200

Início

Instances

Webhook

Settings

Send Message

Chat Controller

Profile Settings

Group Controller

Typebot

OpenAI

Evolution Bot

Dify

n8n

EvoAI

Flowise

Chatwoot

Websocket

SQS

RabbitMQ

Authorizations

Path Parameters

Body

Response