Criar ou obter a caixa de entrada

PUT

/v1/sandbox/receptor

curl --request PUT \
  --url https://sandbox-api.eagleix-corban.com.br/v1/sandbox/receptor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "responderStatus": 200 }'

• Sandbox (só ambiente de teste)

Cria a caixa de entrada de webhooks do canal ou devolve a que já existe (sempre a mesma URL). Cadastre url em PUT /v1/webhooks (sandbox) e os eventos passam a aparecer na página de visualizacaoUrl, já com a assinatura conferida. Opcionalmente define com que status a caixa responde, para testar as retentativas.

Autorizações

• canalOAuth

Corpo da requisição

Tipo de mídiaapplication/json

object

responderStatus

Status HTTP com que a caixa responde aos webhooks.

integer

Allowed values: 200 202 204 400 401 404 500 502 503

Respostas

200

Caixa de entrada do canal.

Tipo de mídiaapplication/json

object

url

required

URL para cadastrar como webhook sandbox.

string format: uri

visualizacaoUrl

required

Página que mostra os eventos recebidos.

string format: uri

responderStatus

required

integer

Example ^generated

{
  "url": "https://example.com",
  "visualizacaoUrl": "https://example.com",
  "responderStatus": 1
}

400

status_invalido ou corpo inválido.

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"