Webhooks

Listar endpoints de webhook, del más nuevo al más antiguo

GET/v1/webhook_endpoints

Parámetros de consulta

• limitenteroopcional

  Elementos por página: de 1 a 100; 25 si se omite.

  de 1 a 100 · por defecto 25

• cursortextoopcional

  El next_cursor de la página anterior: el id del último elemento visto.

Respuestas

• 200Una página de endpoints — objeto
• 401Falta la llave de API o no es válida — Problem
• 403Quien llama no tiene permiso para hacer esto — Problem
• 409La petición choca con el estado actual del recurso — Problem
• 422La petición no es válida — Problem
• 429Demasiadas peticiones — Problem

Crear un endpoint de webhook

POST/v1/webhook_endpoints

La respuesta trae el secreto de firma (whsec_…). Se muestra esta única vez: guárdalo, o rótalo para obtener uno nuevo.

Cabeceras

• idempotency-keytextoopcional

  Repetir una petición con la misma llave devuelve el recurso original. Usa una llave por recurso: la misma llave en una petición de otro tipo de comprobante responde 409.

  de 1 a 255 caracteres

Cuerpo application/json

• urltextoobligatorio

  hasta 2048 caracteres · formato uri

• descriptiontextoopcional

  hasta 200 caracteres

• eventslista de "*" · "document.accepted" · "document.observed" · "document.rejected" · "document.voided" · "document.void_failed" · "email.sent" · "email.failed"opcional

  de 1 a 8 elementos · por defecto ["*"]

• enabledbooleanoopcional

  por defecto true

Respuestas

• 200El endpoint que creó una petición anterior con esta llave, sin su secreto — WebhookEndpoint
• 201El endpoint, con su secreto — WebhookEndpointWithSecret
• 401Falta la llave de API o no es válida — Problem
• 403Quien llama no tiene permiso para hacer esto — Problem
• 409La petición choca con el estado actual del recurso — Problem
• 422La petición no es válida — Problem
• 429Demasiadas peticiones — Problem

Consultar un endpoint de webhook

GET/v1/webhook_endpoints/{id}

Parámetros de la ruta

• idtextoobligatorio

Respuestas

• 200El endpoint — WebhookEndpoint
• 401Falta la llave de API o no es válida — Problem
• 403Quien llama no tiene permiso para hacer esto — Problem
• 404No existe el recurso — Problem
• 409La petición choca con el estado actual del recurso — Problem
• 422La petición no es válida — Problem
• 429Demasiadas peticiones — Problem

Actualizar un endpoint de webhook

PATCH/v1/webhook_endpoints/{id}

Solo cambia lo que se envía. Deshabilitar un endpoint detiene sus entregas.

Parámetros de la ruta

• idtextoobligatorio

Cuerpo application/json

• urltextoopcional

  hasta 2048 caracteres · formato uri

• descriptiontexto o nullopcional

  hasta 200 caracteres

• eventslista de "*" · "document.accepted" · "document.observed" · "document.rejected" · "document.voided" · "document.void_failed" · "email.sent" · "email.failed"opcional

  de 1 a 8 elementos

• enabledbooleanoopcional

Respuestas

• 200El endpoint como está ahora — WebhookEndpoint
• 401Falta la llave de API o no es válida — Problem
• 403Quien llama no tiene permiso para hacer esto — Problem
• 404No existe el recurso — Problem
• 409La petición choca con el estado actual del recurso — Problem
• 422La petición no es válida — Problem
• 429Demasiadas peticiones — Problem

Eliminar un endpoint de webhook y sus entregas

DELETE/v1/webhook_endpoints/{id}

Parámetros de la ruta

• idtextoobligatorio

Respuestas

• 204Eliminado
• 401Falta la llave de API o no es válida — Problem
• 403Quien llama no tiene permiso para hacer esto — Problem
• 404No existe el recurso — Problem
• 409La petición choca con el estado actual del recurso — Problem
• 422La petición no es válida — Problem
• 429Demasiadas peticiones — Problem

Reemplazar el secreto de firma de un endpoint de webhook

POST/v1/webhook_endpoints/{id}/rotate_secret

El secreto anterior deja de firmar de inmediato. El nuevo se muestra esta única vez.

Parámetros de la ruta

• idtextoobligatorio

Respuestas

• 200El endpoint, con su secreto nuevo — WebhookEndpointWithSecret
• 401Falta la llave de API o no es válida — Problem
• 403Quien llama no tiene permiso para hacer esto — Problem
• 404No existe el recurso — Problem
• 409La petición choca con el estado actual del recurso — Problem
• 422La petición no es válida — Problem
• 429Demasiadas peticiones — Problem

Listar las entregas de un endpoint de webhook, de la más nueva a la más antigua

GET/v1/webhook_endpoints/{id}/deliveries

Parámetros de la ruta

• idtextoobligatorio

Parámetros de consulta

• limitenteroopcional

  Elementos por página: de 1 a 100; 25 si se omite.

  de 1 a 100 · por defecto 25

• cursortextoopcional

  El next_cursor de la página anterior: el id del último elemento visto.

• status"pending" · "succeeded" · "failed"opcional

Respuestas

• 200Una página de entregas — objeto
• 401Falta la llave de API o no es válida — Problem
• 403Quien llama no tiene permiso para hacer esto — Problem
• 404No existe el recurso — Problem
• 409La petición choca con el estado actual del recurso — Problem
• 422La petición no es válida — Problem
• 429Demasiadas peticiones — Problem

Reenviar una entrega de webhook

POST/v1/webhook_deliveries/{id}/retry

Deja la entrega en cola para intentarla de inmediato. Una entrega que ya tuvo éxito responde 409.

Parámetros de la ruta

• idtextoobligatorio

Respuestas

• 200La entrega, otra vez pendiente — WebhookDelivery
• 401Falta la llave de API o no es válida — Problem
• 403Quien llama no tiene permiso para hacer esto — Problem
• 404No existe el recurso — Problem
• 409La petición choca con el estado actual del recurso — Problem
• 422La petición no es válida — Problem
• 429Demasiadas peticiones — Problem