signdocs-com-br · Schema
WebhookListResponse
Resposta de listagem de webhooks.
CompanyDigital SignatureBrazilDocument Management
Properties
| Name | Type | Description |
|---|---|---|
| webhooks | array | |
| count | integer | Número total de webhooks registrados. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-webhook-list-response-schema.json",
"title": "WebhookListResponse",
"description": "Resposta de listagem de webhooks.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/signdocs-com-br-webhooks-api-openapi.yml#/components/schemas/WebhookListResponse",
"type": "object",
"required": [
"webhooks",
"count"
],
"properties": {
"webhooks": {
"type": "array",
"items": {
"type": "object",
"required": [
"webhookId",
"url",
"events",
"status",
"createdAt",
"updatedAt"
],
"properties": {
"webhookId": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"events": {
"type": "array",
"items": {
"$ref": "#/$defs/WebhookEventType"
}
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DISABLED"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}
},
"count": {
"type": "integer",
"description": "Número total de webhooks registrados."
}
},
"$defs": {
"WebhookEventType": {
"type": "string",
"description": "Tipos de evento para notificação via webhook.\n\nEventos marcados com (NT65) aplicam-se ao fluxo de crédito consignado INSS\n(Nota Técnica 65/ITI), e só são emitidos para tenants com\n`nt65ComplianceEnabled` habilitado. Ver `docs/18-nt65-consignado.md`.\n",
"enum": [
"TRANSACTION.CREATED",
"TRANSACTION.COMPLETED",
"TRANSACTION.CANCELLED",
"TRANSACTION.FAILED",
"TRANSACTION.EXPIRED",
"TRANSACTION.FALLBACK",
"TRANSACTION.DEADLINE_APPROACHING",
"STEP.PURPOSE_DISCLOSURE_SENT",
"ENROLLMENT.EXPIRING",
"ENROLLMENT.EXPIRED",
"QUOTA.WARNING",
"API.DEPRECATION_NOTICE",
"SIGNING_SESSION.CREATED",
"SIGNING_SESSION.COMPLETED",
"SIGNING_SESSION.CANCELLED",
"SIGNING_SESSION.EXPIRED",
"ENVELOPE.CREATED",
"ENVELOPE.ALL_SIGNED",
"ENVELOPE.CANCELLED",
"ENVELOPE.EXPIRED"
],
"x-enum-descriptions": {
"TRANSACTION.CREATED": "Transação criada.",
"TRANSACTION.COMPLETED": "Transação finalizada com sucesso; evidência disponível.",
"TRANSACTION.CANCELLED": "Transação cancelada pelo integrador ou usuário.",
"TRANSACTION.FAILED": "Falha terminal: todas as etapas passaram e a finalização ainda assim\nnão produziu documento assinado, então a sessão foi encerrada como\n`FAILED` e ninguém vai repetir a tentativa. `data.reason` traz\n`FINALIZATION_FAILED` e `data.detail` o erro.\n\nSó existe no fluxo hospedado. Na API direta o erro volta na resposta\nde `POST /v1/transactions/{id}/finalize` e a chamada pode ser repetida\n— quem falha é quem pode tentar de novo, e por isso não há evento.\n",
"TRANSACTION.EXPIRED": "Transação expirou sem finalização.",
"TRANSACTION.FALLBACK": "Fallback acionado (ex. SERPRO sem biometria).",
"TRANSACTION.DEADLINE_APPROACHING": "(NT65) Faltam ≤2 dias úteis para o prazo de submissão ao INSS.",
"STEP.PURPOSE_DISCLOSURE_SENT": "(NT65) Notificação de divulgação de finalidade enviada ao beneficiário.",
"ENROLLMENT.EXPIRING": "A imagem de referência de um usuário será destruída em breve — disparado\n30 e 7 dias antes. `data.daysUntilExpiry` diz qual dos dois. Recadastre\nantes da data, ou a etapa de comparação passa a falhar com 422.\n",
"ENROLLMENT.EXPIRED": "A imagem de referência foi destruída hoje. O usuário precisa de novo enrollment para assinar.",
"QUOTA.WARNING": "O uso mensal de uma dimensão cruzou 80% do limite do plano. Uma vez por\ndimensão por mês, na requisição que atravessa a marca — não a cada\nchamada acima dela. `data.dimension` diz qual (`monthlyDocuments`,\n`monthlyBiometric`, `monthlyTransactions`, …), com `used`, `limit`,\n`percentUsed` e `resetInSeconds`.\n\nSó mensal. As cotas diárias são trava rígida sem tolerância e\nreiniciam toda noite; avisar sobre elas produziria notificação quase\ntodo dia, que é como um aviso deixa de ser lido.\n",
"API.DEPRECATION_NOTICE": "O tenant chamou um endpoint marcado como deprecated. Uma vez por\nendpoint por dia, com `deprecatedAt`, `sunsetAt`, `replacement` e\n`message` — os mesmos dados dos cabeçalhos `Deprecation` e `Sunset`\n(RFC 8594), entregues onde alguém de fato os lê: os cabeçalhos chegam\nna resposta de uma chamada servidor-a-servidor que ninguém abre.\n",
"SIGNING_SESSION.CREATED": "Sessão de assinatura criada.",
"SIGNING_SESSION.COMPLETED": "Sessão concluída.",
"SIGNING_SESSION.CANCELLED": "Sessão cancelada.",
"SIGNING_SESSION.EXPIRED": "Sessão expirou.",
"ENVELOPE.CREATED": "Envelope multi-assinante criado.",
"ENVELOPE.ALL_SIGNED": "Todas as assinaturas do envelope foram concluídas.",
"ENVELOPE.CANCELLED": "Envelope cancelado; as assinaturas pendentes são encerradas.",
"ENVELOPE.EXPIRED": "Envelope expirou com uma ou mais assinaturas pendentes."
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/signdocs-com-br-webhook-list-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.