webhooks

Registrar un webhook

Registra un endpoint https:// público que recibirá un POST firmado por cada evento suscrito. El secret se devuelve UNA sola vez en esta respuesta: no se almacena (se deriva bajo una llave del servidor) y no vuelve a mostrarse; guárdalo al recibirlo. Máximo 5 webhooks activos por cuenta y modo (409 WEBHOOK_LIMIT_REACHED). La URL se valida contra SSRF: solo https://, hostname público (se rechazan localhost, .local, .internal, literales IP privadas/loopback/link-local y hosts que resuelvan a ellas) y sin credenciales embebidas; en cada entrega se vuelve a resolver el host y la conexión se fija a la IP pública verificada. Con llave ek_test_ el webhook es de sandbox (solo shipment.created/shipment.cancelled del carril de pruebas + ping). Requiere scope webhooks:write.

post/webhooks

Request

  • Base URL: https://api.enviadores.com.mx/api/v1
  • URL: https://api.enviadores.com.mx/api/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Endpoint https:// público en el puerto 443 u 8443 (cualquier otro puerto se rechaza). Se rechazan http, credenciales embebidas, fragmentos, localhost/.local/.internal, literales IP privadas, hosts que resuelvan a rangos privados y hosts que apunten al propio API de Enviadores.

eventsWebhookEvent[] required

Eventos a recibir (duplicados se descartan).

Response

Webhook registrado. secret aparece SOLO aquí.

successunknown required
requestIdstring required

Correlación de logs; también en el header X-Request-Id.

Changes

No recorded changes to this operation across all 1 revision of this API.