Publica o rascunho como versão nova
curl --request POST \
--url https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"draft": {
"trigger": {
"kind": "access_granted",
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"reentry": "once",
"exit_on_access_lost": true,
"exit_when": {
"match": "all",
"rules": [
{
"kind": "has_access",
"negate": true,
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percent": 50,
"step_id": "<string>"
}
]
},
"steps": [
{
"id": "<string>",
"kind": "send_email",
"email": {
"subject": "<string>",
"preheader": "<string>",
"reply_to": "<string>",
"blocks": [
{
"kind": "heading",
"text": "<string>",
"level": 1,
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
]
},
"wait": {
"kind": "delay",
"amount": 1,
"unit": "minutes",
"days": 182
},
"condition": {
"match": "all",
"rules": [
{
"kind": "has_access",
"negate": true,
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percent": 50,
"step_id": "<string>"
}
]
},
"then": "<array>",
"else": "<array>"
}
]
},
"active_runs": 123,
"total_runs": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"published": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 123,
"trigger_kind": "access_granted",
"published_at": "2023-11-07T05:31:56Z",
"definition": {
"trigger": {
"kind": "access_granted",
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"reentry": "once",
"exit_on_access_lost": true,
"exit_when": {
"match": "all",
"rules": [
{
"kind": "has_access",
"negate": true,
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percent": 50,
"step_id": "<string>"
}
]
},
"steps": [
{
"id": "<string>",
"kind": "send_email",
"email": {
"subject": "<string>",
"preheader": "<string>",
"reply_to": "<string>",
"blocks": [
{
"kind": "heading",
"text": "<string>",
"level": 1,
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
]
},
"wait": {
"kind": "delay",
"amount": 1,
"unit": "minutes",
"days": 182
},
"condition": {
"match": "all",
"rules": [
{
"kind": "has_access",
"negate": true,
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percent": 50,
"step_id": "<string>"
}
]
},
"then": "<array>",
"else": "<array>"
}
]
}
}
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Automações
Publicar automação
Confere o rascunho inteiro e grava uma versão imutável para as execuções novas.
POST
/
v1
/
clubs
/
{clubId}
/
workflows
/
{workflowId}
/
publish
Publica o rascunho como versão nova
curl --request POST \
--url https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/workflows/{workflowId}/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"draft": {
"trigger": {
"kind": "access_granted",
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"reentry": "once",
"exit_on_access_lost": true,
"exit_when": {
"match": "all",
"rules": [
{
"kind": "has_access",
"negate": true,
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percent": 50,
"step_id": "<string>"
}
]
},
"steps": [
{
"id": "<string>",
"kind": "send_email",
"email": {
"subject": "<string>",
"preheader": "<string>",
"reply_to": "<string>",
"blocks": [
{
"kind": "heading",
"text": "<string>",
"level": 1,
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
]
},
"wait": {
"kind": "delay",
"amount": 1,
"unit": "minutes",
"days": 182
},
"condition": {
"match": "all",
"rules": [
{
"kind": "has_access",
"negate": true,
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percent": 50,
"step_id": "<string>"
}
]
},
"then": "<array>",
"else": "<array>"
}
]
},
"active_runs": 123,
"total_runs": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"published": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 123,
"trigger_kind": "access_granted",
"published_at": "2023-11-07T05:31:56Z",
"definition": {
"trigger": {
"kind": "access_granted",
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"reentry": "once",
"exit_on_access_lost": true,
"exit_when": {
"match": "all",
"rules": [
{
"kind": "has_access",
"negate": true,
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percent": 50,
"step_id": "<string>"
}
]
},
"steps": [
{
"id": "<string>",
"kind": "send_email",
"email": {
"subject": "<string>",
"preheader": "<string>",
"reply_to": "<string>",
"blocks": [
{
"kind": "heading",
"text": "<string>",
"level": 1,
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
]
},
"wait": {
"kind": "delay",
"amount": 1,
"unit": "minutes",
"days": 182
},
"condition": {
"match": "all",
"rules": [
{
"kind": "has_access",
"negate": true,
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percent": 50,
"step_id": "<string>"
}
]
},
"then": "<array>",
"else": "<array>"
}
]
}
}
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
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.
Path Parameters
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.
Response
A automação, com a versão nova
Show child attributes
Show child attributes