Recurso

Webhooks

4 operaciones · base https://api.bestdoctorsrd.com

GET/v1/webhooks

Listar webhooks

Parámetros

NombreEnTipoObl.
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de WebhookOut
422Error de validaciónHTTPValidationError
POST/v1/webhooks

Crear un webhook

Da de alta un destino. Valida que sea EXTERNO antes de guardarlo. La validación es lo primero y no un detalle: sin ella, un administrador podría apuntar el webhook a `169.254.169.254` y convertir el servidor en un proxy hacia las credenciales del proveedor de nube. Ver `services/webhooks`.

Parámetros

NombreEnTipoObl.
tenant_idquerystring o nuloNo

Cuerpo obligatorio WebhookIn

CampoTipoObl.
urlstring
eventTypeslista de stringNo
descriptionstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaWebhookOut
422Error de validaciónHTTPValidationError
GET/v1/webhooks/deliveries

Listar las entregas

La bitácora de intentos. Es lo que se mira cuando dicen «no me llegó».

Parámetros

NombreEnTipoObl.
subscriptionIdquerystring o nuloNo
statusquerystring o nuloNo
limitqueryintegerNo
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de object
422Error de validaciónHTTPValidationError
PATCH/v1/webhooks/{webhook_id}

Actualizar un webhook

Parámetros

NombreEnTipoObl.
webhook_idpathstring
statusquerystring
tenant_idquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaWebhookOut
422Error de validaciónHTTPValidationError