Entregas de webhooks

Qué salió hacia un endpoint, qué espera un reintento y qué falló, con las respuestas del receptor; una entrega se puede reintentar.

Cargando el índice de búsqueda…

Entregas de webhooks

Objetos

WebhookDelivery

  • idintegerobligatorio

    ID del registro, único entre los registros de su tipo en la tienda.

  • endpoint_idintegerobligatorio

    ID del endpoint del webhook.

  • event_idinteger o nullobligatorio

    ID del evento en GET /v1/events, el mismo que webhook-id de la entrega; null en un evento de prueba.

  • event_typestringobligatorio

    Tipo del evento; ping en un evento de prueba.

  • statusstringobligatorio

    pending — espera un intento; succeeded — el receptor respondió 2xx; failed — se agotaron los reintentos.

    Valores:
    pendingsucceededfailed
  • attempt_countintegerobligatorio

    Intentos realizados.

  • next_attempt_atstring (date-time) o nullobligatorio

    Cuándo sale el próximo intento; null si la entrega está cerrada.

  • last_attemptobject o null

    El último intento; null antes del primero. Solo en la lista.

    Campos · 7
    • numberintegerobligatorio

      Número del intento, desde 1.

    • manualbooleanobligatorio

      El intento se hizo por una solicitud de reintento, no por el calendario.

    • started_atstring (date-time)obligatorio

      Cuándo empezó el intento.

    • duration_msintegerobligatorio

      Cuánto duró el intento, en milisegundos.

    • response_statusinteger o nullobligatorio

      Estado HTTP con el que respondió el receptor; null si no hubo respuesta.

    • response_bodystring o nullobligatorio

      Comienzo del cuerpo de la respuesta del receptor; null si no hubo cuerpo.

    • errorstring o nullobligatorio

      Por qué falló el intento; null si el receptor respondió 2xx. redirect — una respuesta 3xx, las redirecciones no se siguen; http_error — otro estado; timeout — no hubo respuesta en 10 segundos; tls, connection, dns, unreachable — la red; blocked — la dirección lleva a una red interna; invalid_url — la dirección no pasa la verificación.

      Valores:
      invalid_urlblockeddnsconnectiontlstimeoutunreachableredirecthttp_errornull
  • attemptsarray de object

    Todos los intentos en orden. Solo en una entrega.

    Campos · 7
    • numberintegerobligatorio

      Número del intento, desde 1.

    • manualbooleanobligatorio

      El intento se hizo por una solicitud de reintento, no por el calendario.

    • started_atstring (date-time)obligatorio

      Cuándo empezó el intento.

    • duration_msintegerobligatorio

      Cuánto duró el intento, en milisegundos.

    • response_statusinteger o nullobligatorio

      Estado HTTP con el que respondió el receptor; null si no hubo respuesta.

    • response_bodystring o nullobligatorio

      Comienzo del cuerpo de la respuesta del receptor; null si no hubo cuerpo.

    • errorstring o nullobligatorio

      Por qué falló el intento; null si el receptor respondió 2xx. redirect — una respuesta 3xx, las redirecciones no se siguen; http_error — otro estado; timeout — no hubo respuesta en 10 segundos; tls, connection, dns, unreachable — la red; blocked — la dirección lleva a una red interna; invalid_url — la dirección no pasa la verificación.

      Valores:
      invalid_urlblockeddnsconnectiontlstimeoutunreachableredirecthttp_errornull
  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

  • updated_atstring (date-time)obligatorio

    Cuándo cambió el registro por última vez.

Endpoints

Entregas de un endpoint de webhook: lo enviado, lo que espera un reintento y lo que falló

get/webhook-endpoints/{endpoint}/deliveries

Scope: webhooks:read

Parámetros

Ruta

  • endpointintegerobligatorio

    ID del endpoint del webhook.

Query

  • limitinteger

    Tamaño de página: hasta 250 registros; 50 por defecto.

    Mínimo:
    1
    Máximo:
    250
  • cursorstring

    Cursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.

    Largo máximo:
    4096
  • updated_sincestring (date-time)

    Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.

    Patrón:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • statusstring

    Solo las entregas en este estado.

    Valores:
    pendingsucceededfailed

Respuestas

200Éxito

application/json

  • dataarray de WebhookDeliveryobligatorio

    Registros de la página.

  • deletedarray de objectobligatorio

    Registros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.

    Campos · 2
    • idintegerobligatorio

      ID del registro borrado.

    • deleted_atstring (date-time)obligatorio

      Cuándo se borró el registro.

  • next_cursorstring o nullobligatorio

    Cursor de la página siguiente; null en la última.

  • has_morebooleanobligatorio

    true si hay una página siguiente.

  • sync_cursorstring o nullobligatorio

    En la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/webhook-endpoints/{endpoint}/deliveries" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "data": [
    {
      "id": 0,
      "endpoint_id": 0,
      "event_id": 0,
      "event_type": "string",
      "status": "pending",
      "attempt_count": 0,
      "next_attempt_at": "2026-01-15T12:00:00Z",
      "last_attempt": {
        "number": 0,
        "manual": true,
        "started_at": "2026-01-15T12:00:00Z",
        "duration_ms": 0,
        "response_status": 0,
        "response_body": "string",
        "error": "invalid_url"
      },
      "attempts": [
        {
          "number": 0,
          "manual": true,
          "started_at": "2026-01-15T12:00:00Z",
          "duration_ms": 0,
          "response_status": 0,
          "response_body": "string",
          "error": "invalid_url"
        }
      ],
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Una entrega de webhook con todos sus intentos y respuestas del receptor

get/webhook-deliveries/{delivery}

Scope: webhooks:read

Parámetros

Ruta

  • deliveryintegerobligatorio

    ID de la entrega del webhook.

Respuestas

200Éxito

application/json

Devuelve WebhookDelivery

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/webhook-deliveries/{delivery}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "id": 0,
  "endpoint_id": 0,
  "event_id": 0,
  "event_type": "string",
  "status": "pending",
  "attempt_count": 0,
  "next_attempt_at": "2026-01-15T12:00:00Z",
  "last_attempt": {
    "number": 0,
    "manual": true,
    "started_at": "2026-01-15T12:00:00Z",
    "duration_ms": 0,
    "response_status": 0,
    "response_body": "string",
    "error": "invalid_url"
  },
  "attempts": [
    {
      "number": 0,
      "manual": true,
      "started_at": "2026-01-15T12:00:00Z",
      "duration_ms": 0,
      "response_status": 0,
      "response_body": "string",
      "error": "invalid_url"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Enviar al endpoint el evento de prueba ping — un intento firmado con el secreto actual

post/webhook-endpoints/{endpoint}/test

Scope: webhooks:write

Parámetros

Ruta

  • endpointintegerobligatorio

    ID del endpoint del webhook.

Encabezado

  • Idempotency-Keystring

    Clave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.

    Largo mínimo:
    1
    Largo máximo:
    255
    Ejemplo:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Respuestas

202Aceptado: el resultado está en la dirección de Location

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true
  • Locationstring (uri)obligatorio

    Dirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.

application/json

Devuelve WebhookDelivery

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve ConflictProblem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl -X POST "https://api.saleya.app/v1/webhook-endpoints/{endpoint}/test" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 202
{
  "id": 0,
  "endpoint_id": 0,
  "event_id": 0,
  "event_type": "string",
  "status": "pending",
  "attempt_count": 0,
  "next_attempt_at": "2026-01-15T12:00:00Z",
  "last_attempt": {
    "number": 0,
    "manual": true,
    "started_at": "2026-01-15T12:00:00Z",
    "duration_ms": 0,
    "response_status": 0,
    "response_body": "string",
    "error": "invalid_url"
  },
  "attempts": [
    {
      "number": 0,
      "manual": true,
      "started_at": "2026-01-15T12:00:00Z",
      "duration_ms": 0,
      "response_status": 0,
      "response_body": "string",
      "error": "invalid_url"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Reintentar la entrega ahora, con el mismo cuerpo y el mismo webhook-id

post/webhook-deliveries/{delivery}/retry

Scope: webhooks:write

Parámetros

Ruta

  • deliveryintegerobligatorio

    ID de la entrega del webhook.

Encabezado

  • Idempotency-Keystring

    Clave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.

    Largo mínimo:
    1
    Largo máximo:
    255
    Ejemplo:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Respuestas

202Aceptado: el resultado está en la dirección de Location

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true
  • Locationstring (uri)obligatorio

    Dirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.

application/json

Devuelve WebhookDelivery

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve ConflictProblem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl -X POST "https://api.saleya.app/v1/webhook-deliveries/{delivery}/retry" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 202
{
  "id": 0,
  "endpoint_id": 0,
  "event_id": 0,
  "event_type": "string",
  "status": "pending",
  "attempt_count": 0,
  "next_attempt_at": "2026-01-15T12:00:00Z",
  "last_attempt": {
    "number": 0,
    "manual": true,
    "started_at": "2026-01-15T12:00:00Z",
    "duration_ms": 0,
    "response_status": 0,
    "response_body": "string",
    "error": "invalid_url"
  },
  "attempts": [
    {
      "number": 0,
      "manual": true,
      "started_at": "2026-01-15T12:00:00Z",
      "duration_ms": 0,
      "response_status": 0,
      "response_body": "string",
      "error": "invalid_url"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}