Skip to main content
POST
Create Integration
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

Parâmetros de rota

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

Parâmetros do corpo

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.

Exemplo de requisição

O exemplo a seguir cria uma integração para o projeto PROJECT_ID, configurando o webhook.
cURL

Respostas

Exemplo de resposta

Autorizações

x-api-key
string
header
obrigatório

API key del proyecto de Jelou

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>