Automações

Listar automações

Retorna as automações configuradas para o app solicitado, incluindo se cada uma pode ser executada através do gatilho Manual / API.

GET /api/public/v1/automations

Listar automações

curl --request GET \
  --url 'https://api.buildprint.ai/api/public/v1/automations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "automations": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "name": "<string>",
      "enabled": true,
      "triggerKind": "manual",
      "triggerDescription": "<string>",
      "actionKinds": [
        "run_tests"
      ],
      "canRunManually": true,
      "createdByName": "<string>",
      "createdAt": 1,
      "updatedAt": 1,
      "lastRunAt": 1
    }
  ]
}

Automações encontradas

Authorizations

  • Authorization string obrigatório header

    Token da API REST do workspace prefixado com bp_

Query Parameters

  • appId string obrigatório

    ID do App.

Response

application/json
  • automations[] object array

    Automações configuradas para o app solicitado.

    + Show Child Attributes
    • id string

      ID da automação.

    • projectId string

      ID do projeto proprietário da automação.

    • name string

      Nome da automação.

    • enabled boolean

      Se a automação está habilitada no momento.

    • triggerKind string enum enum

      Tipo de gatilho de automação configurado. 6 allowed enum values.

    • triggerDescription string

      Resumo do gatilho legível por humanos.

    • actionKinds[] string enum arrayenum

      Tipos de ações configuradas na automação, em ordem. Allowed values: run_tests, deploy_agent, send_message, send_webhook.

    • canRunManually boolean

      Se esta automação pode ser executada através do gatilho Manual / API.

    • createdByName string | null

      Nome de exibição do usuário que criou a automação.

    • createdAt number

      Data de criação em milissegundos unix.

    • updatedAt number

      Data da última atualização em milissegundos unix.

    • lastRunAt number | null

      Data da execução mais recente em milissegundos unix, se a automação já foi executada.

    • lastRunError string | null

      Último erro de execução registrado, se houver.