Consultar o webhook

GET

/v1/webhooks

const url = 'https://sandbox-api.eagleix-corban.com.br/v1/webhooks';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://sandbox-api.eagleix-corban.com.br/v1/webhooks \
  --header 'Authorization: Bearer <token>'

Autorizações

canalOAuth

Respostas

200

Webhook do canal (nunca devolve o segredo).

application/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"
}

401

Token ausente, inválido ou expirado.

application/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"

404

Nenhum webhook cadastrado (nao_encontrado).

application/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"
}