Skip to main content
POST
/
v1
/
external-support
/
{projectId}
Create Integration
curl --request POST \
  --url https://gateway.jelou.ai/jelouapi/v1/external-support/{projectId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookUrl": "https://my-system.com/webhook/jelou",
  "authType": "no_auth",
  "authorization": "my-secret-token"
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt

Use this file to discover all available pages before exploring further.

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/jelouapi/v1/external-support/{projectId}

​
Path parameters

​
projectId
string
required
Unique identifier of the Jelou project to associate the integration with.

​
Body parameters

​
webhookUrl
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/jelouapi/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

CodeStatusDescription
200OKIntegration created successfully. Includes the signingSecret.
422Unprocessable EntityFields sent in the request contain invalid values or fail validations.
401UnauthorizedInvalid or missing authentication credentials.
500Internal Server ErrorInternal 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

​
Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

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

​
id
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>