Eventos

Listar eventos, del más nuevo al más antiguo

GET/v1/events

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.

• type"document.accepted" · "document.observed" · "document.rejected" · "document.voided" · "document.void_failed" · "email.sent" · "email.failed"opcional
• document_idtextoopcional

  Solo los eventos de este comprobante: lo que le pasó a él y a los correos que lo llevaron.

Respuestas

• 200Una página de eventos — 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

Seguir los eventos en vivo (server-sent events)

GET/v1/events/stream

Un mensaje por evento: id es el id del evento, event su tipo y data el evento en JSON. Una línea de comentario mantiene viva la conexión cada 15 segundos. Un stream abierto sin Last-Event-ID empieza con un mensaje que solo lleva un id: la posición desde la que reanudar si la conexión se pierde antes del primer evento.

Cabeceras

• last-event-idtextoopcional

  Id del último evento recibido. Los eventos posteriores se envían primero; el EventSource de un navegador lo envía solo al reconectar.

Respuestas

• 200El stream; sigue abierto hasta que el cliente lo cierra — text/event-stream
• 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 evento

GET/v1/events/{id}

Parámetros de la ruta

• idtextoobligatorio

Respuestas

• 200El evento — Event
• 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