API de Integração
Webhooks legado

Criar preferência de webhook

Cadastra um endpoint de webhook. Sem `enabledEvents` ou `enabledCourses`, vale `*` (todos). Sistema antigo de webhooks: para novas integrações use as rotas de **Webhooks** (`/webhooks`).

Descontinuado

POST
/webhook/preference

Autorização

apiToken
Api-Token<token>

Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.

Local: header

Corpo da Requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da Resposta

application/json

application/json

curl -X POST "https://example.com/webhook/preference" \  -H "Content-Type: application/json" \  -d '{    "url": "https://www.example.com/slug",    "enabledEvents": [      "made_effective"    ],    "enabledCourses": [      "*"    ]  }'
{  "message": "Url created",  "data": {    "id": 1,    "url": "https://www.example.com/slug",    "status": "enabled",    "enabledEvents": [      "*"    ],    "enabledCourses": [      "*"    ],    "signature": "55385646-2789-4575-9775-16b67362a787"  }}

Listar preferências de webhook

Lista os endpoints de webhook cadastrados. Sistema antigo de webhooks: para novas integrações use as rotas de **Webhooks** (`/webhooks`).

Alterar preferência de webhook

Altera um endpoint de webhook: URL, situação, eventos e cursos. Envie só os campos que quer mudar. Sistema antigo de webhooks: para novas integrações use as rotas de **Webhooks** (`/webhooks`).