Listar envíos de webhooks

GET

/v1/webhook-deliveries

curl --request GET \
  --url 'https://api.iomza.com/v1/webhook-deliveries?limit=50' \
  --header 'Authorization: Bearer <token>'

• Producción

Los últimos eventos enviados a tus endpoints, con el resultado de cada intento: para ver por qué uno no llegó.

Autorizaciones

• apiKey

Parámetros

Parámetros de consulta

job_id

string

<= 40 caracteres

Solo los envíos de los eventos de este job.

limit

integer

por defecto: 50 >= 1 <= 100

Cuántos, 1–100 (50 por defecto).

Respuestas

200

Los envíos, del más nuevo al más antiguo.

Tipo de contenidoapplication/json

object

object

obligatorio

Valor permitido: list

data

obligatorio

Array<object>

Un evento enviado a un endpoint, con el resultado de sus intentos (sin el contenido).

object

id

obligatorio

string

object

obligatorio

string

Valor permitido: webhook_delivery

job_id

obligatorio

string | null

endpoint_id

obligatorio

string | null

url

obligatorio

string

event_id

obligatorio

string

event_type

obligatorio

string

status

obligatorio

string

Valores permitidos: pending delivered failed

attempts

obligatorio

number

last_status_code

obligatorio

number | null

last_error

obligatorio

string | null

next_attempt_at

obligatorio

string | null formato: date-time

created_at

obligatorio

string formato: date-time

delivered_at

obligatorio

string | null formato: date-time

Ejemplo

{
  "object": "list",
  "data": [
    {
      "object": "webhook_delivery",
      "status": "pending"
    }
  ]
}

400

Campos inválidos: details lista cada problema con su ruta.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

401

La API key falta, no es válida o está revocada.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

429

Demasiadas peticiones: espera y reintenta. Lo responde la pasarela, así que el cuerpo puede ser distinto.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

500

Nuestro: reintenta, y avísanos si persiste.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

503

No disponible por un momento: reintenta en unos segundos.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}