Endpoints de webhooks
Direcciones a las que la tienda envía eventos firmados según Standard Webhooks; el secreto de firma, su rotación y un evento de prueba.
Endpoints de webhooks
Objetos
WebhookEndpoint
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
versionintegerobligatorioVersión del registro: crece con cada cambio. Para cambiar el registro, envíela como ETag en If-Match.
urlstringobligatorioDirección HTTPS a la que se envían las entregas.
descriptionstring o nullobligatorioDescripción del endpoint; null si no se indicó.
enabled_eventsarray de stringobligatorioTipos de evento a los que está suscripto el endpoint, como order.created; son los tipos de GET /v1/events. Un tipo cuyo scope de lectura perdió la aplicación no se entrega.
api_versionstringobligatorioVersión de la API cuyo formato sigue el cuerpo de las entregas, fijada al crear el endpoint.
- Valor:
v1
statusstringobligatorioenabled — las entregas salen; disabled — lo desactivó la aplicación o la plataforma (disabled_reason).
- Valores:
enableddisabled
disabled_reasonstring o nullobligatorioPor qué la plataforma desactivó el endpoint: failing — durante 72 horas las entregas no tuvieron ni un éxito. null si está activo o si lo desactivó la aplicación. Activarlo borra el motivo.
- Valores:
failingnull
failing_sincestring o nullobligatorioDesde cuándo las entregas al endpoint no tienen ni un éxito; a las 72 horas la plataforma lo desactiva. null si la última entrega tuvo éxito.
previous_secret_expires_atstring (date-time) o nullobligatorioDespués de rotar el secreto, las entregas se firman también con el anterior hasta este momento; null si no hay secreto anterior.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
WebhookEndpointSecret
endpoint_idintegerobligatorioID del endpoint del webhook.
secretstringobligatorioSecreto de firma según Standard Webhooks: whsec_ y la clave base64 de HMAC-SHA256. Guardalo solo en tu servidor.
Endpoints
Listar los endpoints de webhook de la app
get/webhook-endpoints
Scope: webhooks:read
Parámetros
Query
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor 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})$
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros 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
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn 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-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos 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
curl "https://api.saleya.app/v1/webhook-endpoints" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"version": 0,
"url": "string",
"description": "string",
"enabled_events": [
"string"
],
"api_version": "v1",
"status": "enabled",
"disabled_reason": "failing",
"failing_since": "string",
"previous_secret_expires_at": "2026-01-15T12:00:00Z",
"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"
}Agregar un endpoint de webhook y suscribirlo a tipos de evento
post/webhook-endpoints
Scope: webhooks:write
Parámetros
Encabezado
Idempotency-KeystringClave ú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
Cuerpo de la solicitud application/json
urlstringobligatorioDirección HTTPS a la que se envían las entregas.
- Largo máximo:
- 2048
descriptionstring o nullDescripción del endpoint; null si no se indicó.
- Largo máximo:
- 255
enabled_eventsarray de stringobligatorioTipos de evento a los que está suscripto el endpoint, como order.created; son los tipos de GET /v1/events. Un tipo cuyo scope de lectura perdió la aplicación no se entrega.
- Mínimo de elementos:
- 1
- Máximo de elementos:
- 93
- Sin repetidos
- Valores:
order.createdorder.updatedorder.status_changedorder.paidorder.cancelledpayment.createdpayment.succeededpayment.status_changedpayment.updatedrefund.createdrefund.completedrefund.status_changedrefund.updatedfiscal_document.createdfiscal_document.updatedfiscal_document.issuedfiscal_document.failedfiscal_document.annulledtax_period.status_changedmoney_transaction.createdmoney_transaction.updatedmoney_transaction.deletedpos_shift.openedpos_shift.closedpos_shift.updatedpos_cash_movement.createdgift_card.createdgift_card.updatedgift_card_transaction.createdcustomer_account.createdcustomer_account.updatedcustomer_account_entry.createdcustomer_account_entry.updatedsupplier.createdsupplier.updatedsupplier.deletedsupplier_bill.createdsupplier_bill.updatedsupplier_bill.postedsupplier_bill.voidedsupplier_bill.deletedsupplier_bill_payment.createdsupplier_bill_payment.updatedsupplier_bill_payment.deletedsettlement_agreement.createdsettlement_agreement.updatedsettlement_agreement.deletedsettlement_offset.createdsettlement_offset.updatedsettlement_offset.voidedpurchase_order.createdpurchase_order.updatedpurchase_order.status_changedpurchase_order.deletedgoods_receipt.createdgoods_receipt.updatedgoods_receipt.voidedsupplier_return.createdsupplier_return.updatedsupplier_return.status_changedsupplier_return.deletedconsignment_settlement.createdconsignment_settlement.updatedconsignment_settlement.postedconsignment_settlement.voidedtax_withholding.createdtax_withholding.updatedtax_withholding.annulledtax_withholding.deletedproduct.createdproduct.updatedproduct.deletedinventory_level.updatedstock_movement.createdstock_movement.updatedlot.createdlot.updatedlot.deletedlocation_transfer.createdlocation_transfer.updatedstocktake.createdstocktake.status_changedstocktake.updatedcustomer.createdcustomer.updatedcustomer.deletedcustomer_group.createdcustomer_group.updatedcustomer_group.deletedprice_list.createdprice_list.updatedprice_list.deletedbulk_operation.finished
Respuestas
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
Locationstring (uri)obligatorioDirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.
application/json
Devuelve WebhookEndpoint
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
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-AfterintegerSegundos 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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
webhook_endpoint_limit_reachedLa app tiene el máximo de endpoints de webhook - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
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
curl -X POST "https://api.saleya.app/v1/webhook-endpoints" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"url": "string",
"description": "string",
"enabled_events": [
"order.created"
]
}{
"id": 0,
"version": 0,
"url": "string",
"description": "string",
"enabled_events": [
"string"
],
"api_version": "v1",
"status": "enabled",
"disabled_reason": "failing",
"failing_since": "string",
"previous_secret_expires_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Obtener un endpoint de webhook
get/webhook-endpoints/{endpoint}
Scope: webhooks:read
Parámetros
Ruta
endpointintegerobligatorioID del endpoint del webhook.
Respuestas
200Éxito
Encabezados
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve WebhookEndpoint
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos 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
curl "https://api.saleya.app/v1/webhook-endpoints/{endpoint}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"version": 0,
"url": "string",
"description": "string",
"enabled_events": [
"string"
],
"api_version": "v1",
"status": "enabled",
"disabled_reason": "failing",
"failing_since": "string",
"previous_secret_expires_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
patch/webhook-endpoints/{endpoint}
Scope: webhooks:write
Parámetros
Ruta
endpointintegerobligatorioID del endpoint del webhook.
Encabezado
Idempotency-KeystringClave ú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
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Cuerpo de la solicitud application/json
urlstringDirección HTTPS a la que se envían las entregas.
- Largo máximo:
- 2048
descriptionstring o nullDescripción del endpoint; null si no se indicó.
- Largo máximo:
- 255
enabled_eventsarray de stringTipos de evento a los que está suscripto el endpoint, como order.created; son los tipos de GET /v1/events. Un tipo cuyo scope de lectura perdió la aplicación no se entrega.
- Mínimo de elementos:
- 1
- Máximo de elementos:
- 93
- Sin repetidos
- Valores:
order.createdorder.updatedorder.status_changedorder.paidorder.cancelledpayment.createdpayment.succeededpayment.status_changedpayment.updatedrefund.createdrefund.completedrefund.status_changedrefund.updatedfiscal_document.createdfiscal_document.updatedfiscal_document.issuedfiscal_document.failedfiscal_document.annulledtax_period.status_changedmoney_transaction.createdmoney_transaction.updatedmoney_transaction.deletedpos_shift.openedpos_shift.closedpos_shift.updatedpos_cash_movement.createdgift_card.createdgift_card.updatedgift_card_transaction.createdcustomer_account.createdcustomer_account.updatedcustomer_account_entry.createdcustomer_account_entry.updatedsupplier.createdsupplier.updatedsupplier.deletedsupplier_bill.createdsupplier_bill.updatedsupplier_bill.postedsupplier_bill.voidedsupplier_bill.deletedsupplier_bill_payment.createdsupplier_bill_payment.updatedsupplier_bill_payment.deletedsettlement_agreement.createdsettlement_agreement.updatedsettlement_agreement.deletedsettlement_offset.createdsettlement_offset.updatedsettlement_offset.voidedpurchase_order.createdpurchase_order.updatedpurchase_order.status_changedpurchase_order.deletedgoods_receipt.createdgoods_receipt.updatedgoods_receipt.voidedsupplier_return.createdsupplier_return.updatedsupplier_return.status_changedsupplier_return.deletedconsignment_settlement.createdconsignment_settlement.updatedconsignment_settlement.postedconsignment_settlement.voidedtax_withholding.createdtax_withholding.updatedtax_withholding.annulledtax_withholding.deletedproduct.createdproduct.updatedproduct.deletedinventory_level.updatedstock_movement.createdstock_movement.updatedlot.createdlot.updatedlot.deletedlocation_transfer.createdlocation_transfer.updatedstocktake.createdstocktake.status_changedstocktake.updatedcustomer.createdcustomer.updatedcustomer.deletedcustomer_group.createdcustomer_group.updatedcustomer_group.deletedprice_list.createdprice_list.updatedprice_list.deletedbulk_operation.finished
statusstringenabled — las entregas salen; disabled — lo desactivó la aplicación o la plataforma (disabled_reason).
- Valores:
enableddisabled
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve WebhookEndpoint
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
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
curl -X PATCH "https://api.saleya.app/v1/webhook-endpoints/{endpoint}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"url": "string",
"description": "string",
"enabled_events": [
"order.created"
],
"status": "enabled"
}{
"id": 0,
"version": 0,
"url": "string",
"description": "string",
"enabled_events": [
"string"
],
"api_version": "v1",
"status": "enabled",
"disabled_reason": "failing",
"failing_since": "string",
"previous_secret_expires_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Eliminar un endpoint de webhook
delete/webhook-endpoints/{endpoint}
Scope: webhooks:write
Parámetros
Ruta
endpointintegerobligatorioID del endpoint del webhook.
Encabezado
Idempotency-KeystringClave ú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
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Respuestas
204Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
Sin cuerpo
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
in_use_conflictRegistro en uso - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
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
curl -X DELETE "https://api.saleya.app/v1/webhook-endpoints/{endpoint}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'Emitir un nuevo secreto de firma: el anterior sigue firmando las entregas junto con él durante 24 horas
post/webhook-endpoints/{endpoint}/rotate-secret
Scope: webhooks:write
Parámetros
Ruta
endpointintegerobligatorioID del endpoint del webhook.
Encabezado
Idempotency-KeystringClave ú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
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve WebhookEndpoint
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerSegundos 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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
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
curl -X POST "https://api.saleya.app/v1/webhook-endpoints/{endpoint}/rotate-secret" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"version": 0,
"url": "string",
"description": "string",
"enabled_events": [
"string"
],
"api_version": "v1",
"status": "enabled",
"disabled_reason": "failing",
"failing_since": "string",
"previous_secret_expires_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Obtener el secreto de firma de las entregas de un endpoint de webhook
get/webhook-endpoints/{endpoint}/secret
Scope: webhooks:write
Parámetros
Ruta
endpointintegerobligatorioID del endpoint del webhook.
Respuestas
200Éxito
application/json
Devuelve WebhookEndpointSecret
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos 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
curl "https://api.saleya.app/v1/webhook-endpoints/{endpoint}/secret" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"endpoint_id": 0,
"secret": "string"
}