Cadastrar ou atualizar o webhook

PUT

/v1/webhooks

curl --request PUT \
  --url https://sandbox-api.eagleix-corban.com.br/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://api.suaempresa.com.br/webhooks/corban", "eventos": [ "proposta.criada" ] }'

• Sandbox (só ambiente de teste)

Cadastra o webhook do canal (um por canal) ou atualiza a URL e os eventos. Na criação a resposta traz o segredo, mostrado uma única vez; atualizar não o repete. Sem eventos, assina todos os estados.

Autorizações

• canalOAuth

Corpo da requisição^required

Tipo de mídiaapplication/json

object

url

required

Https, domínio público (sem IP, sem credenciais, sem redes internas).

string format: uri

eventos

Tipos assinados. Vazio ou ausente = todos os estados.

Array<string>

Allowed values: proposta.criada proposta.aguardando_formalizacao proposta.formalizada proposta.aprovada proposta.recusada proposta.cancelada proposta.falha

Respostas

200

Webhook atualizado (sem segredo).

Tipo de mídiaapplication/json

object

ambiente

required

string

Allowed values: SANDBOX REAL

url

required

string

eventos

required

Array<string>

ativo

required

boolean

criadoEm

required

string format: date-time

atualizadoEm

required

string format: date-time

segredo

Só no cadastro e na troca de segredo. Guarde; não é mostrado de novo.

string

segredoAnteriorValidoAte

Presente durante a rotação, até quando o segredo anterior ainda vale.

string format: date-time

Example

{
  "ambiente": "SANDBOX"
}

201

Webhook criado; guarde o segredo.

Tipo de mídiaapplication/json

object

ambiente

required

string

Allowed values: SANDBOX REAL

url

required

string

eventos

required

Array<string>

ativo

required

boolean

criadoEm

required

string format: date-time

atualizadoEm

required

string format: date-time

segredo

Só no cadastro e na troca de segredo. Guarde; não é mostrado de novo.

string

segredoAnteriorValidoAte

Presente durante a rotação, até quando o segredo anterior ainda vale.

string format: date-time

Example

{
  "ambiente": "SANDBOX"
}

Headers

Cache-Control

string

Allowed value: no-store

400

URL ou eventos inválidos (url_invalida, eventos_invalidos).

Tipo de mídiaapplication/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized"
}

401

Token ausente, inválido ou expirado.

Tipo de mídiaapplication/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized",
  "message": "token inválido ou expirado",
  "requestId": "8d1f0c2a9b7e4c3d2a1b0f9e"
}

Headers

WWW-Authenticate

string

Example

Bearer error="invalid_token"