Create integration

Create Integration

curl --request POST \
  --url https://gateway.jelou.ai/platform/v1/external-support/{projectId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "webhookUrl": "https://my-system.com/webhook/jelou",
  "authType": "no_auth",
  "authorization": "my-secret-token"
}
'

import requests

url = "https://gateway.jelou.ai/platform/v1/external-support/{projectId}"

payload = {
    "webhookUrl": "https://my-system.com/webhook/jelou",
    "authType": "no_auth",
    "authorization": "my-secret-token"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    webhookUrl: 'https://my-system.com/webhook/jelou',
    authType: 'no_auth',
    authorization: 'my-secret-token'
  })
};

fetch('https://gateway.jelou.ai/platform/v1/external-support/{projectId}', 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://gateway.jelou.ai/platform/v1/external-support/{projectId}",
  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([
    'webhookUrl' => 'https://my-system.com/webhook/jelou',
    'authType' => 'no_auth',
    'authorization' => 'my-secret-token'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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://gateway.jelou.ai/platform/v1/external-support/{projectId}"

	payload := strings.NewReader("{\n  \"webhookUrl\": \"https://my-system.com/webhook/jelou\",\n  \"authType\": \"no_auth\",\n  \"authorization\": \"my-secret-token\"\n}")

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

	req.Header.Add("x-api-key", "<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://gateway.jelou.ai/platform/v1/external-support/{projectId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"webhookUrl\": \"https://my-system.com/webhook/jelou\",\n  \"authType\": \"no_auth\",\n  \"authorization\": \"my-secret-token\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway.jelou.ai/platform/v1/external-support/{projectId}")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhookUrl\": \"https://my-system.com/webhook/jelou\",\n  \"authType\": \"no_auth\",\n  \"authorization\": \"my-secret-token\"\n}"

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

{
  "id": "INTEGRATION_ID",
  "brainId": "BRAIN_ID",
  "webhookUrl": "https://my-system.com/webhook/jelou",
  "authType": "bearer",
  "signingSecret": "a1b2c3d4...signing_secret_hex",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

POST

external-support

{projectId}

Create Integration

curl --request POST \
  --url https://gateway.jelou.ai/platform/v1/external-support/{projectId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "webhookUrl": "https://my-system.com/webhook/jelou",
  "authType": "no_auth",
  "authorization": "my-secret-token"
}
'

import requests

url = "https://gateway.jelou.ai/platform/v1/external-support/{projectId}"

payload = {
    "webhookUrl": "https://my-system.com/webhook/jelou",
    "authType": "no_auth",
    "authorization": "my-secret-token"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    webhookUrl: 'https://my-system.com/webhook/jelou',
    authType: 'no_auth',
    authorization: 'my-secret-token'
  })
};

fetch('https://gateway.jelou.ai/platform/v1/external-support/{projectId}', 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://gateway.jelou.ai/platform/v1/external-support/{projectId}",
  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([
    'webhookUrl' => 'https://my-system.com/webhook/jelou',
    'authType' => 'no_auth',
    'authorization' => 'my-secret-token'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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://gateway.jelou.ai/platform/v1/external-support/{projectId}"

	payload := strings.NewReader("{\n  \"webhookUrl\": \"https://my-system.com/webhook/jelou\",\n  \"authType\": \"no_auth\",\n  \"authorization\": \"my-secret-token\"\n}")

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

	req.Header.Add("x-api-key", "<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://gateway.jelou.ai/platform/v1/external-support/{projectId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"webhookUrl\": \"https://my-system.com/webhook/jelou\",\n  \"authType\": \"no_auth\",\n  \"authorization\": \"my-secret-token\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway.jelou.ai/platform/v1/external-support/{projectId}")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhookUrl\": \"https://my-system.com/webhook/jelou\",\n  \"authType\": \"no_auth\",\n  \"authorization\": \"my-secret-token\"\n}"

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

{
  "id": "INTEGRATION_ID",
  "brainId": "BRAIN_ID",
  "webhookUrl": "https://my-system.com/webhook/jelou",
  "authType": "bearer",
  "signingSecret": "a1b2c3d4...signing_secret_hex",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

The signingSecret is only shown in the creation response. Store it securely.

Description

Creates a new integration between Jelou and your external support panel. Upon completion, Jelou will generate a unique signingSecret associated with the project.

Endpoint

POST https://gateway.jelou.ai/platform/v1/external-support/{projectId}

Path parameters

string

required

Unique identifier of the Jelou project to associate the integration with.

Body parameters

string

required

URL of the endpoint in your system that will receive events sent by Jelou. Must be a publicly accessible HTTPS URL.Example: https://my-system.com/webhook/jelou

Authentication

All requests must include the x-api-key header with your Jelou project API key.

x-api-key: API_KEY

Request example

The following example creates an integration for project PROJECT_ID, configuring the webhook.

cURL

curl --request POST \
  --url https://gateway.jelou.ai/platform/v1/external-support/PROJECT_ID \
  --header 'x-api-key: API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "webhookUrl": "https://my-system.com/webhook/jelou"
  }'

Responses

Code	Status	Description
200	OK	Integration created successfully. Includes the `signingSecret`.
422	Unprocessable Entity	Fields sent in the request contain invalid values or fail validations.
401	Unauthorized	Invalid or missing authentication credentials.
500	Internal Server Error	Internal server error.

Response example

{
  "message": [
    "Integration created successfully"
  ],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "id": "INTEGRATION_ID",
    "brainId": "PROJECT_ID",
    "webhookUrl": "https://my-system.com/webhook/jelou",
    "authType": "no_auth",
    "signingSecret": "SIGNING_SECRET",
    "createdAt": "2026-01-15T10:30:00.000Z"
  }
}

Authorizations

x-api-key

string

header

required

API key del proyecto de Jelou

Path Parameters

projectId

string

required

Unique identifier of the Jelou project

Body

application/json

webhookUrl

string<uri>

required

Webhook URL where events will be sent

Example:

"https://my-system.com/webhook/jelou"

authType

enum<string>

default:no_auth

Authentication type for invoking the webhook

Available options:

bearer,

api_key,

basic,

no_auth

authorization

string

Credentials for authenticating when invoking the webhook

Example:

"my-secret-token"

Response

Integration created successfully

string

Example:

"INTEGRATION_ID"

brainId

string

Example:

"BRAIN_ID"

webhookUrl

string

Example:

"https://my-system.com/webhook/jelou"

authType

string

Example:

"bearer"

signingSecret

string

Example:

"a1b2c3d4...signing_secret_hex"

createdAt

string<date-time>

HMAC-SHA256 Signature

Get integration

⌘I

API reference

Send Messages

Campaigns

Conversations

Metrics

Users

Resources

Widget

Datum

External Support Panel

Memory Management

Description

Endpoint

Path parameters

Body parameters

Authentication

Request example

Responses

Response example

Authorizations

Path Parameters

Body

Response

​Description

​Endpoint

​Path parameters

​Body parameters

​Authentication

​Request example

​Responses

​Response example

Authorizations

Path Parameters

Body

Response

Description

Endpoint

Path parameters

Body parameters

Authentication

Request example

Responses

Response example