Package dev.rafex.ether.webhook.model

Webhook payload, signature, and verification result models. More...

Functions
record	WebhookPayload (String deliveryId, String eventType, Instant occurredAt, String contentType, byte[] body, Map< String, List< String > > headers)
	Payload de un webhook.
record	WebhookSignature (String algorithm, String value, long timestampEpochMilli)
	Firma de un payload de webhook.
record	WebhookVerificationResult (boolean valid, String reason, WebhookSignature signature)
	Resultado de la verificación de una firma de webhook.

Detailed Description

Webhook payload, signature, and verification result models.

Function Documentation

WebhookPayload()

record dev.rafex.ether.webhook.model.WebhookPayload	(	String	deliveryId,
		String	eventType,
		Instant	occurredAt,
		String	contentType,
		byte[]	body,
		Map< String, List< String > >	headers )

Payload de un webhook.

Es un record inmutable que contiene todos los datos necesarios para enviar un webhook a un endpoint externo.

Parameters

deliveryId	ID de entrega único
eventType	tipo de evento
occurredAt	momento en que ocurrió el evento
contentType	tipo de contenido del cuerpo
body	cuerpo del payload en bytes
headers	cabeceras HTTP adicionales

Crea un payload con contenido JSON.

Parameters

deliveryId	ID de entrega
eventType	tipo de evento
value	objeto a serializar como JSON

Returns

el payload creado

Crea un payload con contenido de texto plano.

Parameters

deliveryId	ID de entrega
eventType	tipo de evento
value	contenido de texto

Returns

el payload creado

Añade una cabecera al payload.

Parameters

name	nombre de la cabecera
value	valor de la cabecera

Returns

un nuevo payload con la cabecera añadida

Convierte el payload a una especificación de petición HTTP.

Parameters

endpoint

URL del endpoint

Returns

la especificación de petición

Definition at line 52 of file WebhookPayload.java.

References dev.rafex.ether.http.client.model.HttpMethod.POST, dev.rafex.ether.json.JsonUtils.toJsonBytes(), and WebhookPayload().

Referenced by WebhookPayload().

Here is the call graph for this function:

Here is the caller graph for this function:

WebhookSignature()

record dev.rafex.ether.webhook.model.WebhookSignature	(	String	algorithm,
		String	value,
		long	timestampEpochMilli )

Firma de un payload de webhook.

Es un record inmutable que contiene la firma, el algoritmo usado y la marca de tiempo de la firma.

Parameters

algorithm	algoritmo criptográfico usado
value	valor de la firma en base64
timestampEpochMilli	marca de tiempo en milisegundos desde epoch

Definition at line 38 of file WebhookSignature.java.

Referenced by WebhookVerificationResult().

Here is the caller graph for this function:

WebhookVerificationResult()

record dev.rafex.ether.webhook.model.WebhookVerificationResult	(	boolean	valid,
		String	reason,
		WebhookSignature	signature )

Resultado de la verificación de una firma de webhook.

Es un record inmutable que indica si la verificación fue exitosa y proporciona detalles en caso de fallo.

Parameters

valid	true si la firma es válida
reason	motivo del fallo (si aplica)
signature	la firma verificada

Crea un resultado de verificación exitosa.

Parameters

signature

la firma verificada

Returns

el resultado de verificación

Crea un resultado de verificación fallida.

Parameters

reason	motivo del fallo
signature	la firma (puede ser null)

Returns

el resultado de verificación

Definition at line 38 of file WebhookVerificationResult.java.

References WebhookSignature(), and WebhookVerificationResult().

Referenced by WebhookVerificationResult().

Here is the call graph for this function:

Here is the caller graph for this function: