Consultar Webhook - GYRA+ Docs

curl --location 'https://gyra-core.gyramais.com.br/webhook/findBy'
--header 'Authorization: Bearer {seu_token_jwt}'

fetch("https://gyra-core.gyramais.com.br/webhook/findBy", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {seu_token_jwt}",
  },
})
  .then(res => res.json())
  .then(console.log)

import requests

url = "https://gyra-core.gyramais.com.br/webhook/findBy"
headers = {
  "Authorization": "Bearer {seu_token_jwt}"
}
response = requests.get(url, headers=headers)
print(response.json())

[
  {
    "id": "6612a7f344eb43f000000000",
    "createdAt": "2025-06-18T23:48:24.706Z",
    "updatedAt": "2025-06-18T23:48:24.706Z",
    "organizationId": "6612a7f3fa9e086b00000000",
    "type": "REPORT_FINISHED",
    "url": "https://exemplo.gyramais.com.br/arquivo",
    "apiKey": null
  },
  {
    "id": "6612a7f366b264ff00000000",
    "createdAt": "2025-08-26T17:00:37.398Z",
    "updatedAt": "2025-08-26T17:00:37.398Z",
    "organizationId": "6612a7f3fa9e086b00000000",
    "type": "REPORT_FINISHED",
    "url": "https://exemplo.gyramais.com.br/arquivo",
    "apiKey": null
  }
]

{
  "code": 401,
  "message": "Token de acesso inválido."
}

Quando usar

Use este endpoint para consultar o webhook ativo por ID (ou pelo contexto da organização). Você pode usar para auditoria de configuração, troubleshooting de entrega de eventos ou validação antes de atualizar/remover um webhook.

Autenticação

Bearer JWT no header Authorization.

Parâmetros

Nome	Local	Tipo	Obrigatório	Descrição
`webhookId`	`query`	`string`	`não`	Webhook Id, If you do not add the webhookId, the organizationId extracted from the token is used as a search.

curl --location 'https://gyra-core.gyramais.com.br/webhook/findBy'
--header 'Authorization: Bearer {seu_token_jwt}'

fetch("https://gyra-core.gyramais.com.br/webhook/findBy", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {seu_token_jwt}",
  },
})
  .then(res => res.json())
  .then(console.log)

import requests

url = "https://gyra-core.gyramais.com.br/webhook/findBy"
headers = {
  "Authorization": "Bearer {seu_token_jwt}"
}
response = requests.get(url, headers=headers)
print(response.json())

[
  {
    "id": "6612a7f344eb43f000000000",
    "createdAt": "2025-06-18T23:48:24.706Z",
    "updatedAt": "2025-06-18T23:48:24.706Z",
    "organizationId": "6612a7f3fa9e086b00000000",
    "type": "REPORT_FINISHED",
    "url": "https://exemplo.gyramais.com.br/arquivo",
    "apiKey": null
  },
  {
    "id": "6612a7f366b264ff00000000",
    "createdAt": "2025-08-26T17:00:37.398Z",
    "updatedAt": "2025-08-26T17:00:37.398Z",
    "organizationId": "6612a7f3fa9e086b00000000",
    "type": "REPORT_FINISHED",
    "url": "https://exemplo.gyramais.com.br/arquivo",
    "apiKey": null
  }
]

{
  "code": 401,
  "message": "Token de acesso inválido."
}