Pular para o conteúdo principal
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.

O signingSecret é exibido apenas na resposta de criação. Armazene-o com segurança.

​
Descrição

Cria uma nova integração entre o Jelou e seu painel de atendimento externo. Ao concluir, o Jelou gerará um signingSecret único associado ao projeto.

​
Endpoint

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

​
Parâmetros de rota

​
projectId
string
obrigatório
Identificador único do projeto Jelou ao qual a integração será associada.

​
Parâmetros do corpo

​
webhookUrl
string
obrigatório
URL do endpoint no seu sistema que receberá os eventos enviados pelo Jelou. Deve ser uma URL pública acessível via HTTPS.Exemplo: https://meu-sistema.com/webhook/jelou

​
Autenticação

Todas as requisições devem incluir o cabeçalho x-api-key com a API key do projeto Jelou. 
x-api-key: API_KEY

​
Exemplo de requisição

O exemplo a seguir cria uma integração para o projeto PROJECT_ID, configurando o 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://meu-sistema.com/webhook/jelou"
  }'

​
Respostas

CódigoStatusDescrição
200OKIntegração criada com sucesso. Inclui o signingSecret.
422Unprocessable EntityOs campos enviados contêm valores inválidos ou não passam nas validações.
401UnauthorizedCredenciais de autenticação inválidas ou ausentes.
500Internal Server ErrorErro interno do servidor.

​
Exemplo de resposta

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

Autorizações

​
Authorization
string
header
obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de caminho

​
projectId
string
obrigatório

Unique identifier of the Jelou project

Corpo

application/json
​
webhookUrl
string<uri>
obrigatório

Webhook URL where events will be sent

Exemplo:

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

​
authType
enum<string>
padrão:no_auth

Authentication type for invoking the webhook

Opções disponíveis:
bearer,
api_key,
basic,
no_auth
​
authorization
string

Credentials for authenticating when invoking the webhook

Exemplo:

"my-secret-token"

Resposta

Integration created successfully

​
id
string
Exemplo:

"INTEGRATION_ID"

​
brainId
string
Exemplo:

"BRAIN_ID"

​
webhookUrl
string
Exemplo:

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

​
authType
string
Exemplo:

"bearer"

​
signingSecret
string
Exemplo:

"a1b2c3d4...signing_secret_hex"

​
createdAt
string<date-time>