Saltar al contenido principal
WEBHOOK

Encabezados

Content-Type
string
requerido

Siempre JSON.

Allowed value: "application/json"
X-Webhook-Event
string
requerido

Nombre del evento.

Allowed value: "business.newEnrollment"
X-Webhook-Id
string
requerido

Identificador del tipo de evento.

Allowed value: "2"
X-Webhook-Event-Id
string<uuid>
requerido

Identificador único de esta ocurrencia del evento, en formato UUID v4. Se repite en todos los reintentos y en los reenvíos. Úsalo para detectar entregas duplicadas. Ver Entregas y reintentos.

Ejemplo:

"3f6c2a1e-8b4d-4c2a-9e1f-7a5b6c8d9e0f"

X-Webhook-Timestamp
string
requerido

Momento en que Pruff generó la entrega, en segundos Unix.

Ejemplo:

"1769547728"

X-Webhook-Signature
string
requerido

Timestamp y firma HMAC-SHA256 de la entrega, con el formato t={timestamp},v1={firma}. Ver Headers y firma.

Ejemplo:

"t=1769547728,v1=2789cdd9...e734d"

X-Webhook-Attempt
enum<string>
requerido

Número de intento, de 1 a 4.

Opciones disponibles:
1,
2,
3,
4
X-Webhook-Replay
string

Solo viene en un reenvío pedido a Pruff, y siempre vale true. En una entrega normal y en sus reintentos no viene. Ver «Reenvíos» en Entregas y reintentos.

Allowed value: "true"

Cuerpo

application/json
identifier
string
requerido

RUT de la empresa enrolada.

Ejemplo:

"76111111-1"

name
string
requerido

Razón social de la empresa. Si Pruff no la conoce, llega un texto de reemplazo como Razón social desconocida o Razon Social Desconocida. En casos excepcionales llega vacía ("").

Ejemplo:

"Cliente Ejemplo SpA"

enrolledPath
enum<string>
requerido

Canal por el que se enroló la empresa:

  • publicMarket: Mercado Público.
  • enrollmentLink: link de enrolamiento.
  • universalEnrollmentLink: link de enrolamiento universal.
  • myAccounts: desde Pruff, por un usuario de tu empresa.
  • api: API de clientes.
  • other: cualquier otro canal.
Opciones disponibles:
publicMarket,
enrollmentLink,
universalEnrollmentLink,
myAccounts,
api,
other
enrolledById
integer

Identificador del usuario que enroló la empresa. No viene cuando no hay un usuario asociado, por ejemplo en un enrolamiento por la API o por un link de enrolamiento universal.

enrolledByName
string | null

Nombre del usuario que enroló la empresa. No viene cuando no hay usuario.

enrolledByEmail
string<email>

Email del usuario que enroló la empresa. No viene cuando no hay usuario.

Respuesta

200

Cualquier respuesta 2xx da la entrega por recibida. Pruff reintenta ante 408, 429, 5xx, un timeout o un error de red. Cualquier otro 4xx y cualquier 3xx son una falla definitiva y no se reintentan. Ver Entregas y reintentos.