Skip to navigation
Referencia APIWebhook Endpoints

Consultar un endpoint y su secreto de firma

Devuelve el endpoint y su signingSecret, buscándolo por ID o por UID en la aplicación de la cuenta y ambiente autenticados. Requiere una llave con permiso de escritura; las llaves de solo lectura reciben 403. La respuesta usa Cache-Control: no-store. Permite verificar webhooks en runtimes sin almacenamiento persistente. No entrega secretos de otra cuenta ni del otro ambiente.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

idstringRequired
ID o UID del webhook endpoint

Response

Endpoint con secreto de firma
idstringOptional
ID del endpoint
urlstringOptionalformat: "uri"
URL que recibe los webhooks
descriptionstringOptional

Descripción del endpoint

disabledbooleanOptional

Si el endpoint está deshabilitado

metadatamap from strings to stringsOptional
Metadata personalizada
createdAtdatetimeOptional

Fecha de creación

updatedAtdatetimeOptional

Última actualización

signingSecretstringOptional

Secreto para verificar las firmas de los webhooks. Se devuelve al crear o consultar el endpoint con una llave de escritura; nunca al listar endpoints.

Errors

403
Forbidden Error
404
Not Found Error