> ## Documentation Index > Fetch the complete documentation index at: https://docs.useweve.com/llms.txt > Use this file to discover all available pages before exploring further. # Automações > As automações do club, em qualquer estado. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/workflows openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.useweve.com description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: outgoing-webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: community - name: mentorships - name: agents - name: lives - name: students - name: auth - name: campaigns - name: workflows - name: email - name: exports - name: certificates - name: terms - name: mcp - name: gamification - name: support - name: help paths: /v1/clubs/{clubId}/workflows: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - workflows summary: As automações do club description: | A listagem da tela: filtra, busca e pagina no servidor. `counts` é do CLUB inteiro, não do recorte — é o que deixa as abas e o vazio contarem a mesma história: uma tela que abre sem nada em "Todas" precisa saber se o club não tem automação nenhuma ou se só tem arquivadas. operationId: listWorkflows parameters: - name: q in: query description: Busca no nome. schema: type: string maxLength: 200 - name: status in: query required: false description: | Um ou vários (`status=draft&status=paused`). Ausente traz o que está DE PÉ — rascunho, ativa e pausada —, nunca a arquivada: uma lista que abre mostrando o que alguém tirou de vista desfaz o arquivamento a cada visita. schema: type: array items: $ref: '#/components/schemas/WorkflowStatus' - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 20 - name: page in: query required: false schema: type: integer minimum: 1 default: 1 responses: '200': description: A página pedida content: application/json: schema: $ref: '#/components/schemas/WorkflowList' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid schemas: WorkflowStatus: type: string enum: - draft - active - paused - archived WorkflowList: type: object required: - data - total - counts properties: data: type: array items: $ref: '#/components/schemas/Workflow' total: description: Quantas automações o recorte tem, além desta página. type: integer counts: $ref: '#/components/schemas/WorkflowCounts' Workflow: type: object required: - id - name - status - draft - active_runs - total_runs - created_at - updated_at properties: id: type: string format: uuid name: type: string status: $ref: '#/components/schemas/WorkflowStatus' draft: $ref: '#/components/schemas/WorkflowDefinition' published: $ref: '#/components/schemas/WorkflowVersion' active_runs: type: integer total_runs: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time WorkflowCounts: type: object required: - draft - active - paused - archived description: Quantas automações o CLUB tem em cada estado, fora do recorte. properties: draft: type: integer active: type: integer paused: type: integer archived: type: integer ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string WorkflowDefinition: type: object description: > A automação inteira. `reentry` diz quantas vezes a mesma pessoa passa por ela: `once` (padrão, uma vez na vida), `one_at_a_time` (a cada evento, mas nunca duas em curso) ou `always` (uma por evento). `exit_on_access_lost` encerra a execução quando a matrícula que disparou é revogada ou vence (só `access_granted`). `exit_when` é a meta, conferida antes de cada passo. properties: trigger: $ref: '#/components/schemas/WorkflowTrigger' reentry: type: string enum: - once - one_at_a_time - always exit_on_access_lost: type: boolean exit_when: $ref: '#/components/schemas/WorkflowCondition' steps: type: array maxItems: 60 items: $ref: '#/components/schemas/WorkflowStep' WorkflowVersion: type: object required: - id - number - trigger_kind - published_at properties: id: type: string format: uuid number: type: integer trigger_kind: $ref: '#/components/schemas/WorkflowTriggerKind' published_at: type: string format: date-time definition: $ref: '#/components/schemas/WorkflowDefinition' WorkflowTrigger: type: object properties: kind: $ref: '#/components/schemas/WorkflowTriggerKind' delivery_ids: type: array maxItems: 50 items: type: string format: uuid product_ids: type: array maxItems: 50 items: type: string format: uuid course_ids: type: array maxItems: 50 items: type: string format: uuid lesson_ids: type: array maxItems: 50 items: type: string format: uuid tag_ids: type: array maxItems: 50 items: type: string format: uuid level_ids: description: Os níveis de `level_reached` (o `id` de `GamificationLevel`). type: array maxItems: 50 items: type: string format: uuid WorkflowCondition: type: object properties: match: type: string enum: - all - any rules: type: array maxItems: 10 items: $ref: '#/components/schemas/WorkflowRule' WorkflowStep: type: object description: > Um passo. `id` é escolhido pela tela (letras, números, `-` e `_`, até 40) e precisa ser ESTÁVEL entre versões: é por ele que os números somam e que uma regra de e-mail aberto cita o envio. Só a condição tem `then` e `else`, que ao terminar seguem para o passo depois dela. `exit` encerra a execução. `add_tag` e `remove_tag` marcam e desmarcam a pessoa com `tag_id` — e disparam os gatilhos de tag das OUTRAS automações: as da cadeia que levou a esta execução, esta inclusive, ficam de fora. `award_points` dá `points` à pessoa com o motivo `note`, que ela lê no extrato; vale com a gamificação desligada também, como o ajuste da equipe. required: - id - kind properties: id: type: string minLength: 1 maxLength: 40 kind: type: string enum: - send_email - wait - condition - exit - add_tag - remove_tag - award_points points: description: Os pontos de `award_points`. type: integer minimum: 1 maximum: 10000 note: description: O motivo de `award_points`, que o aluno lê no extrato. type: string maxLength: 140 tag_id: description: A tag de `add_tag` e `remove_tag`. type: string format: uuid email: $ref: '#/components/schemas/WorkflowEmail' wait: $ref: '#/components/schemas/WorkflowWait' condition: $ref: '#/components/schemas/WorkflowCondition' then: type: array items: $ref: '#/components/schemas/WorkflowStep' else: type: array items: $ref: '#/components/schemas/WorkflowStep' WorkflowTriggerKind: type: string description: > O fato que abre a execução, gravado na mesma transação do fato: - `access_granted` / `access_revoked`: matrícula concedida ou revogada, por qualquer porta (compra, concessão, importação, link, turma). Filtro: `delivery_ids`. - `purchase_paid` / `purchase_refunded`: compra aprovada, e reembolso ou chargeback. Filtro: `product_ids`. - `subscription_past_due` / `subscription_canceled`: assinatura atrasada ou cancelada. Filtro: `product_ids`. - `lesson_completed`: aula concluída — uma vez por aluno e aula, mesmo desfazendo e concluindo de novo. Filtro: `course_ids`, `lesson_ids`. - `course_completed`: a última aula publicada do curso concluída. Filtro: `course_ids`. - `certificate_issued`: o certificado de conclusão foi emitido para o aluno. Uma vez por aluno e curso. Chega junto com o `course_completed` quando o curso emite certificado — e é o gatilho a usar quando a mensagem fala do certificado, porque ele só dispara se houve certificado. Filtro: `course_ids`. - `tag_added` / `tag_removed`: o aluno ganhou ou perdeu uma tag — pela equipe ou por um passo de outra automação. Filtro: `tag_ids`. A marcação feita por um passo nunca abre execução de uma automação que já esteja na cadeia que levou a ela: não há laço, nem direto nem passando por outra automação. - `level_reached`: o aluno chegou a um nível da gamificação — pelos pontos que ganhou estudando, por um ajuste da equipe ou pelo passo `award_points`. Quem salta dois degraus de uma vez chega aos dois. Filtro: `level_ids`. Os pontos dados por uma automação nunca a reabrem pelo nível que fizeram subir. enum: - access_granted - access_revoked - purchase_paid - purchase_refunded - subscription_past_due - subscription_canceled - lesson_completed - course_completed - certificate_issued - tag_added - tag_removed - level_reached WorkflowRule: type: object description: | Uma pergunta, respondida no MOMENTO do passo, contra o banco: - `has_access` (`delivery_ids`): matrícula ativa em alguma das entregas. - `in_cohort` (`cohort_ids`): matrícula ativa em alguma das turmas. - `purchased_product` (`product_ids`): compra paga e não reembolsada. - `completed_lesson` (`lesson_id`): concluiu a aula. - `course_progress` (`course_id`, `percent`): concluiu ao menos essa porcentagem das aulas publicadas. - `opened_email` / `clicked_email` (`step_id`): o e-mail de um passo anterior desta execução foi aberto / clicado. Abertura é aproximada. - `has_tag` (`tag_ids`): tem alguma das tags. `negate` inverte a resposta. required: - kind properties: kind: type: string enum: - has_access - in_cohort - purchased_product - completed_lesson - course_progress - opened_email - clicked_email - has_tag negate: type: boolean delivery_ids: type: array maxItems: 50 items: type: string format: uuid cohort_ids: type: array maxItems: 50 items: type: string format: uuid product_ids: type: array maxItems: 50 items: type: string format: uuid tag_ids: type: array maxItems: 50 items: type: string format: uuid lesson_id: type: string format: uuid course_id: type: string format: uuid percent: type: integer minimum: 0 maximum: 100 step_id: type: string maxLength: 40 WorkflowEmail: type: object properties: subject: type: string maxLength: 200 preheader: type: string maxLength: 200 reply_to: type: string maxLength: 254 blocks: type: array maxItems: 50 items: $ref: '#/components/schemas/MailBlock' WorkflowWait: type: object description: > `delay` espera `amount` × `unit` (minutes, hours, days — até 365 dias) contados da chegada ao passo. `before_expiry` espera até `days` dias antes do fim da matrícula que disparou, relido a cada vez: estender o acesso remarca a espera; matrícula vitalícia segue direto. Só com o gatilho `access_granted`. properties: kind: type: string enum: - delay - before_expiry amount: type: integer minimum: 0 unit: type: string enum: - minutes - hours - days days: type: integer minimum: 0 maximum: 365 MailBlock: type: object description: > Um bloco do corpo do e-mail. A lista de tipos é FECHADA e quem escreve o HTML é a API — o club manda só o conteúdo de cada bloco. `text` é o título, o parágrafo (com `**negrito**`, `*itálico*`, `[link](https://…)` e quebra de linha) ou o rótulo do botão; variáveis entram como `{{name}}` ou `{{first_name|valor quando vazio}}` e saem sempre escapadas, nunca como marcação. `url` é o destino do botão (ou o link da imagem): `https://`, `http://`, `mailto:` ou `{{classroom_url}}/caminho`. A imagem é uma mídia PÚBLICA e pronta da biblioteca — a URL assinada de uma privada venceria dentro da caixa de entrada. required: - kind properties: kind: $ref: '#/components/schemas/MailBlockKind' text: type: string maxLength: 5000 level: type: integer enum: - 1 - 2 url: type: string maxLength: 2000 media_id: type: string format: uuid alt: type: string maxLength: 200 MailBlockKind: type: string enum: - heading - paragraph - button - image - divider responses: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ````