Consultar detalhes de uma subscrição

Este endpoint é utilizado para consultar detalhes de uma subscrição existente.

Requisição

GET https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions/{ID}

Escopos JWT: webhooks-engine/manage:subscriptions webhooks-engine/read:subscriptions

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>

Respostas

Código	Descrição
200	Sucesso. Corpo da resposta contém os detalhes da subscrição.
401	Não autorizado
404	Subscrição não encontrada

Exemplos de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");

const requestOptions = {
  method: "GET",
  headers: headers,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions/3a396c21-f644-4013-8e06-470d59f3f719",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request GET 'https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions/3a396c21-f644-4013-8e06-470d59f3f719' \
-H 'Authorization: Bearer <token>'

Exemplo de Sucesso

{
  "links": {
    "self": "https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions/3a396c21-f644-4013-8e06-470d59f3f719"
  },
  "data": {
    "type": "subscriptions",
    "id": "3a396c21-f644-4013-8e06-470d59f3f719",
    "attributes": {
      "event": "document.status.signed",
      "name": "safra-signed-documents-callback",
      "context": "doc-signature",
      "state": "active",
      "targetUrl": "https://exemplo.com.br/meus/callbacks"
    }
  }
}