Справочник API публикуется на английском языке.

Create a routine trigger

POST/api/routines/{id}/triggers
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Create a routine trigger.

A webhook response includes secretMaterial.webhookUrl and secretMaterial.webhookSecret. The webhookSecret is a credential: never write its value, or a header containing it, in a chat reply, comment, document or task. For a signed or bearer trigger, the URL and signing mode may be shared in chat. With signingMode none the URL alone starts the routine, so treat that URL as a credential too and do not write it in chat. Instead link the person to the routine's Triggers page, //routines//triggers, as a Markdown link, where Veyra Intelligence shows a key once: for a trigger still awaiting setup, link //routines//triggers?triggerSetup= and tell them to choose Generate new key; otherwise tell them to choose Edit webhook, then Replace key. Replacing the key invalidates the earlier one.

Авторизация

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. Как работают ключи.

Параметры пути

idstringОбязательныйThe routine's id.

Тело запроса

application/json · обязательно

kindstringОбязательныйWhich kind of object this is; it decides which other fields apply.one of: "schedule", "webhook", "api"
labelstring | nullНеобязательныйat most 120 characters
enabledbooleanНеобязательный
cronExpressionstringНеобязательныйRequired with kind: "schedule".at least 1 character
timezonestringНеобязательныйOnly with kind: "schedule".at least 1 character
setupPendingbooleanНеобязательныйOnly with kind: "webhook".
signingModestringНеобязательныйOnly with kind: "webhook".one of: "bearer", "app_webhook", "hmac_sha256", "github_hmac", "fireflies_hmac", "none"
replayWindowSecintegerНеобязательныйOnly with kind: "webhook".≥ 30≤ 86400

Ответы

201SuccessCreated; the body holds the new resource.
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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Routines