Skip to content

Actualizar config de webhook

PATCH /api/webhooks/config

Setea la URL base y/o el token compartido (webhook_secret, write-only: se guarda cifrado y no vuelve en ninguna respuesta). El mismo token va en tu backend para validar el header x-webhook-token de cada dispatch. Requiere webhooks:manage.

FieldTypeDescription
webhook_urlstringoptionalURL base de tu backend a la que Neike despacha los webhooks. Example: "https://tu-backend.com".
webhook_secretstringoptionalToken compartido (write-only: se guarda cifrado y no vuelve en ninguna respuesta). Neike lo manda en la cabecera x-webhook-token de cada dispatch; tu backend lo valida. null para limpiarlo. Example: "whsec_abc123…".
StatusDescriptionSchema
200WebhookConfigResponseDto
Terminal window
curl -X PATCH https://api.neike.dev/api/webhooks/config \
-H "x-neike-api-key: whk_live_…" \
-H "Content-Type: application/json" \
-d '{
"webhook_url": "https://tu-backend.com",
"webhook_secret": "whsec_abc123…"
}'
FieldTypeDescription
webhook_urlstringrequiredURL base configurada. Example: "https://tu-backend.com".
webhook_secret_setbooleanrequiredtrue si hay token compartido (x-webhook-token) configurado. Example: true.
webhook_secret_hintstringrequiredHint enmascarado del token para reconocerlo (whsec_…abcd). El valor completo solo se devuelve al generarlo, una única vez. Example: "whsec_…abcd".
configuredbooleanrequiredtrue si hay webhook_url configurada. Example: true.
signature_headerstringrequiredCabecera con la que Neike firma cada dispatch. Example: "x-webhook-token".
dispatch_urlsDispatchUrlsDtorequired