La referencia de la API se publica en inglés.

Fire a public routine trigger

POST/api/routine-triggers/public/{publicId}/fire
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 4 · Historial

Fire a public routine trigger.

Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

publicIdstringObligatorioThe public's id.

Cabeceras

X-Veyra-Source-Run-TokenstringOpcional
X-Veyra-Idempotency-ScopestringOpcionalone of: "trigger", "routine"
Idempotency-KeystringOpcional

Cuerpo de la solicitud

application/json · obligatorio

Cualquier objeto JSON.

Respuestas

202SuccessAccepted; the work continues in the background.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
415Unsupported media typeThe body is not in a supported content type.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Routines