Compartilhar via

Eduframe

A Eduframe é uma solução completa para provedores de treinamento comercial e escolas de negócios para atrair mais alunos, gerenciar &automatizar a administração do curso e proporcionar a experiência de aprendizagem final. O Eduframe integra-se perfeitamente ao Canvas LMS. O conector abre a oportunidade de integrar facilmente seus aplicativos de software existentes ao Eduframe, como seu CRM e software contábil.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Equipe de Desenvolvimento do Eduframe
URL https://eduframe.co
Email dev@drieam.nl
Metadados do conector
Publicador Microsoft
Site https://eduframe.co
Política de privacidade https://drieam.com/security-and-privacy/
Categorias Dados

A Eduframe gerencia e automatiza a administração de cursos para provedores de treinamento comercial e escolas de negócios. Usando esse conector, é possível conectar diferentes ferramentas com o Eduframe para gerenciar automaticamente cursos, usuários, faturas e muito mais.

Pré-requisitos

Para usar esse conector, você precisará de uma licença do Eduframe. Você pode encontrar mais informações sobre o Eduframe e como obter uma licença aqui.

Se você já tiver uma licença do Eduframe, verifique se os Aplicativos Lógicos do Azure estão habilitados para seu ambiente. Se você quiser habilitar essa integração, poderá enviar um email por email support@eduframe.nl.

Como obter credenciais

Se você usar esse conector pela primeira vez, será solicitado que você faça logon no Eduframe e autorize esse conector. Depois de autorizado, você poderá usar esse conector e todos os seus recursos.

Introdução ao conector

O Eduframe fornece webhooks que atuam como gatilhos para suas automações. Podemos criar um novo fluxo que será disparado sempre que um novo usuário for adicionado ao Eduframe. Ao criar um novo fluxo, você pode selecionar esse conector e escolher "Assinar no webhook" como um gatilho. Em seguida, em "Item de eventos", selecione "user.created". Você pode adicionar mais, mas por enquanto só estamos interessados neste.

Em seguida, queremos saber qual usuário foi adicionado ao eduframe. Para fazer isso, podemos adicionar uma nova etapa desse conector chamada "Obter um usuário". Esta etapa exigirá uma ID de um usuário. Podemos usar a ID da entidade do webhook.

Agora que sabemos quem é o novo usuário no Eduframe, podemos enviar um email para essa pessoa. Como exemplo, usaremos o conector do Outlook, mas isso pode ser qualquer provedor de email. Adicione uma nova etapa e selecione "Enviar um email". Aqui, podemos preencher o email do usuário, um assunto e o email que desejamos enviar. Observe que, no corpo do email, você pode usar outros atributos do usuário, como o nome e o sobrenome.

Quando terminarmos de escrever o email, podemos salvar esse fluxo. Agora, sempre que um novo usuário for adicionado ao Eduframe, essa pessoa receberá um email de boas-vindas.

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar um curso

Adicione um curso à sua administração.
Adicionar um iva de fatura

Adicione um iva de fatura que pode ser usado na fatura.
Adicionar um usuário

Adicione um usuário à sua administração.
Adicionar uma autenticação

Adicionar um método de autenticação a um usuário existente
Adicionar uma categoria

Adicione uma categoria à sua administração.
Adicionar uma conta

Adicione uma conta à sua administração.
Adicionar uma fatura

Adicione uma fatura à sua administração.
Excluir uma autenticação de um usuário

Exclua uma das autenticações de um usuário. Observe que você não pode excluir a última autenticação!
Listar todas as categorias

Obtenha todas as categorias.
Listar todas as contas

Obtenha todas as contas.
Listar todas as faturas

Obtenha todas as faturas.
Listar todos os cursos

Obtenha todos os cursos.
Listar todos os ivas de fatura

Obter todos os ivas de fatura
Listar todos os rótulos

Obtenha todos os rótulos.
Listar todos os usuários

Obtenha todos os usuários.
Obter as autenticações de um usuário

Obtenha uma lista de autenticações que pertencem a um usuário específico.
Obter todas as variantes do catálogo

Obtenha todas as variantes do catálogo.
Obter um curso

Obter um único curso por ID
Obter um usuário

Obtenha um único usuário por ID.
Obter uma categoria

Obter uma categoria por id
Obter uma conta

Obtenha uma conta por ID.
Obter uma fatura

Obtenha uma única fatura por ID.

Adicionar um curso

ID da operação:
Post_courses

Adicione um curso à sua administração.

Parâmetros

Nome Chave Obrigatório Tipo Description
id
 id integer

Identificador exclusivo do curso
nome
 name True string

O nome do curso.
posição
 position number

Classificação da posição do curso. Mais baixo é maior.
signup_url
 signup_url string

URL para a página de inscrição deste curso.
slug_history
 slug_history array of string

Lista de lesmas antigas, chamadas antigas serão redirecionadas.
Avatar
 avatar string

URL para uma imagem de avatar redimensionada (300x200^).
certificate_template_id
 certificate_template_id number

Identificador do modelo de certificado vinculado opcionalmente.
Categoria
 category_id True number

Identificador da categoria do curso.
codificar
 code True string

O código do curso.
custar
 cost string

O preço a ser pago por este curso.
cost_scheme
 cost_scheme string

Como o curso deve ser pago por padrão.
is_published
 is_published boolean

Booliano que representa o status publicável do curso.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

Retornos

Corpo
course

Adicionar um iva de fatura

ID da operação:
Post_invoice_vats

Adicione um iva de fatura que pode ser usado na fatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
id
 id integer

Idenitfier exclusivo do iva da fatura.
nome
 name True string

Nome do iva da fatura.
porcentagem
 percentage True string

Número que representa o percentual de IVA.

Retornos

Corpo
invoice_vat

Adicionar um usuário

ID da operação:
Post_users

Adicione um usuário à sua administração.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome
 first_name True string

Nome do usuário.
Nome do meio
 middle_name string

Nome do meio do usuário.
Sobrenome
 last_name True string

Sobrenome do usuário.
Email
 email True string

O email do usuário.
Número de telefone
 phone string

O número de telefone do usuário.
Assinar boletim informativo
 wants_newsletter boolean

O usuário deseja receber boletins informativos?
Criar autenticação
 with_authentication boolean

Crie uma autenticação para o usuário, de modo que o usuário possa fazer logon.
localidade
 locale string

A localidade do usuário.
label_ids
 label_ids array of number
id
 id integer

Identificador exclusivo do endereço.
destinatário
 addressee string

O destinatário do endereço.
address
 address True string

Concatenação do número da rua e da casa.
postal_code
 postal_code True string

Uma cadeia de caracteres que representa o código postal.
city
 city True string

Uma cadeia de caracteres que representa a cidade.
country
 country True string

Uma cadeia de caracteres que representa o país.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.
notes_user
 notes_user string

Observação breve sobre o usuário.

Retornos

Corpo
user

Adicionar uma autenticação

ID da operação:
Post_authentication

Adicionar um método de autenticação a um usuário existente

Parâmetros

Nome Chave Obrigatório Tipo Description
user_id
 user_id True integer

A ID do usuário à qual essa autenticação pertence.
authentication_provider_type
 authentication_provider_type True string

O tipo do provedor de autenticação.
uid
 uid True string

O identificador exclusivo dessa autenticação que corresponde a uma ID exclusiva do IDP.

Retornos

Corpo
authentication

Adicionar uma categoria

ID da operação:
Post_categories

Adicione uma categoria à sua administração.

Parâmetros

Nome Chave Obrigatório Tipo Description
id
 id integer

Identificador exclusivo da categoria.
Nome
 name True string

Título da categoria.
Description
 description string

A descrição da categoria.
posição
 position number

Classificação da posição da categoria. Mais baixo é maior.
parent_id
 parent_id number

Identificador exclusivo da categoria pai
Avatar
 avatar string

URL para o avatar de categoria.
Publicado
 is_published boolean

Se a categoria deve ser publicada no site.
courses_count
 courses_count number

Número de cursos diretamente vinculados a essa categoria.
children_count
 children_count number

Número de categorias de filhos diretamente vinculadas a essa categoria.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.
avatar_url
 avatar_url string

URL para uma imagem de avatar redimensionada (300x200^).

Retornos

Corpo
category

Adicionar uma conta

ID da operação:
Post_accounts

Adicione uma conta à sua administração.

Parâmetros

Nome Chave Obrigatório Tipo Description
nome
 name True string

O nome da conta.
email
 email string

Uma cadeia de caracteres que representa o email de cobrança da conta.
id
 id integer

Identificador exclusivo do endereço.
destinatário
 addressee string

O destinatário do endereço.
address
 address True string

Concatenação do número da rua e da casa.
postal_code
 postal_code True string

Uma cadeia de caracteres que representa o código postal.
city
 city True string

Uma cadeia de caracteres que representa a cidade.
country
 country True string

Uma cadeia de caracteres que representa o país.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

Retornos

Corpo
account

Adicionar uma fatura

ID da operação:
Post_invoices

Adicione uma fatura à sua administração.

Parâmetros

Nome Chave Obrigatório Tipo Description
Conta
 account_id True number

Identificador da conta.
account_name
 account_name string

O nome da conta que está pagando. É copiado para a fatura e, portanto, não é atualizado automaticamente se o nome da conta for alterado.
moeda
 currency True string

A moeda da fatura.
id
 id integer

Identificador exclusivo do item da fatura.
Unidades
 units True number

O número de unidades do item da fatura.
Description
 name True string

O nome do item da fatura.
Preço
 unit_price True string

O preço de uma única unidade.
IVA
 invoice_vat_id number

Identificador do iva da fatura.
Variante do Catálogo
 catalog_variant_id number

Identificador da variante do catálogo.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.
funcionalidade
 feature string

Alguma descrição da fatura exibida na fatura.
nota de rodapé
 footnote string

A nota exibida na parte inferior da fatura.

Retornos

Corpo
invoice

Excluir uma autenticação de um usuário

ID da operação:
Delete_authentication_by_user_id

Exclua uma das autenticações de um usuário. Observe que você não pode excluir a última autenticação!

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do usuário
 user_id True integer

Identificador do usuário.
ID de autenticação
 authentication_id True integer

Identificador da autenticação.

Listar todas as categorias

ID da operação:
Get_categories

Obtenha todas as categorias.

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.
Classificar
 sort array

Classifique os resultados. Alterar a ordem usando <sort_by>:[asc|desc]

Retornos

response
array of category

Listar todas as contas

ID da operação:
Get_accounts

Obtenha todas as contas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.

Retornos

response
array of account

Listar todas as faturas

ID da operação:
Get_invoices

Obtenha todas as faturas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.

Retornos

response
array of invoice

Listar todos os cursos

ID da operação:
Get_courses

Obtenha todos os cursos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.
Classificar
 sort array

Classifique os resultados. Alterar a ordem usando <sort_by>:[asc|desc]

Retornos

response
array of course

Listar todos os ivas de fatura

ID da operação:
Get_invoice_vats

Obter todos os ivas de fatura

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.

Retornos

response
array of invoice_vat

Listar todos os rótulos

ID da operação:
Get_labels

Obtenha todos os rótulos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.
Filtrar o tipo de modelo do rótulo
 model_type string

Filtrar rótulos com base no tipo de modelo.

Retornos

response
array of label

Listar todos os usuários

ID da operação:
Get_users

Obtenha todos os usuários.

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.
Classificar
 sort array

Classifique os resultados. Alterar a ordem usando <sort_by>:[asc|desc]

Retornos

response
array of user

Obter as autenticações de um usuário

ID da operação:
Get_authentications_by_user_id

Obtenha uma lista de autenticações que pertencem a um usuário específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.
ID do usuário
 user_id True integer

Identificador do usuário.

Retornos

response
array of authentication
ID da operação:
Get_catalog_variants

Obtenha todas as variantes do catálogo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Número da página
 page integer

Número da página a ser obtido.
Registros por página
 per_page integer

Número de registros por página.

Retornos

response
array of catalog_variant

Obter um curso

ID da operação:
Get_courses_id

Obter um único curso por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do curso
 id True integer

Identificador do curso.

Retornos

Corpo
course

Obter um usuário

ID da operação:
Get_users_id

Obtenha um único usuário por ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do usuário
 id True integer

Identificador do usuário.

Retornos

Corpo
user

Obter uma categoria

ID da operação:
Get_categories_id

Obter uma categoria por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da categoria
 id True integer

Identificador da categoria.

Retornos

Corpo
category

Obter uma conta

ID da operação:
Get_accounts_id

Obtenha uma conta por ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da conta
 id True integer

Identificador da conta.

Retornos

Corpo
account

Obter uma fatura

ID da operação:
Get_invoices_id

Obtenha uma única fatura por ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da fatura
 id True integer

Identificador da fatura.

Retornos

Corpo
invoice

Gatilhos

Assinar um webhook

Assine um webhook para ser notificado sobre atualizações de registro.

Assinar um webhook

ID da operação:
Post_webhooks

Assine um webhook para ser notificado sobre atualizações de registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
id
 id string

Identificador exclusivo do webhook. (uma UUID).
ativo
 active boolean

Estado do webhook.
events
 events True array of string

Matriz de eventos que devem disparar esse webhook.

Retornos

Corpo
webhook_payload

Definições

conta

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo da conta.
nome
 name string

O nome da conta.
email
 email string

Uma cadeia de caracteres que representa o email de cobrança da conta.
account_type
 account_type string

O tipo de conta.
address
 address address
phone
 phone string

Uma cadeia de caracteres que representa o número de telefone da conta.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.
signup_answers
 signup_answers array of customField

Lista de respostas de inscrição para essa conta.

address

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo do endereço.
destinatário
 addressee string

O destinatário do endereço.
address
 address string

Concatenação do número da rua e da casa.
postal_code
 postal_code string

Uma cadeia de caracteres que representa o código postal.
city
 city string

Uma cadeia de caracteres que representa a cidade.
country
 country string

Uma cadeia de caracteres que representa o país.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

autenticação

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo da autenticação.
user_id
 user_id integer

A ID do usuário à qual essa autenticação pertence.
authentication_provider_id
 authentication_provider_id integer

A ID do provedor de autenticação.
uid
 uid string

O identificador exclusivo dessa autenticação que corresponde a uma ID exclusiva do IDP.
Se o OTP estiver habilitado para esse logon.
 otp_enabled

Caso o provedor de autenticação seja Eduframe, indica se uma senha única está habilitada para esse logon, é falsa para qualquer outro provedor.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

customField

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo da resposta de inscrição.
value
 value string

O valor formatado da resposta.
signup_question_id
 signup_question_id integer

Identificador exclusivo da pergunta.

categoria

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo da categoria.
Nome
 name string

Título da categoria.
Description
 description string

A descrição da categoria.
posição
 position number

Classificação da posição da categoria. Mais baixo é maior.
parent_id
 parent_id number

Identificador exclusivo da categoria pai
Avatar
 avatar string

URL para o avatar de categoria.
Publicado
 is_published boolean

Se a categoria deve ser publicada no site.
courses_count
 courses_count number

Número de cursos diretamente vinculados a essa categoria.
children_count
 children_count number

Número de categorias de filhos diretamente vinculadas a essa categoria.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.
avatar_url
 avatar_url string

URL para uma imagem de avatar redimensionada (300x200^).

curso

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo do curso
nome
 name string

O nome do curso.
posição
 position number

Classificação da posição do curso. Mais baixo é maior.
signup_url
 signup_url string

URL para a página de inscrição deste curso.
Avatar
 avatar string

URL para uma imagem de avatar redimensionada (300x200^).
certificate_template_id
 certificate_template_id number

Identificador do modelo de certificado vinculado opcionalmente.
Categoria
 category_id number

Identificador da categoria do curso.
codificar
 code string

O código do curso.
custar
 cost string

O preço a ser pago por este curso.
cost_scheme
 cost_scheme string

Como o curso deve ser pago por padrão.
is_published
 is_published boolean

Booliano que representa o status publicável do curso.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

usuário

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo do usuário.
Número do funcionário
 employee_number string

O número de funcionário desse usuário.
Nome
 first_name string

Nome do usuário.
Nome do meio
 middle_name string

Nome do meio do usuário.
Sobrenome
 last_name string

Sobrenome do usuário.
Email
 email string

O email do usuário.
Número de telefone
 phone string

O número de telefone do usuário.
labels
 labels array of label
Assinar boletim informativo
 wants_newsletter boolean

O usuário deseja receber boletins informativos?
Criar autenticação
 with_authentication boolean

Crie uma autenticação para o usuário, de modo que o usuário possa fazer logon.
localidade
 locale string

A localidade do usuário.
address
 address address
Avatar
 avatar_url string

O caminho relativo da URL para o avatar.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

fatura

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo da fatura.
reference_id
 reference_id string

ID de referência da Fatura. É usado para localizar a fatura.
Conta
 account_id number

Identificador da conta.
número
 number string

O número da fatura que é exclusivo por educador. Se deixado vazio, ele cria automaticamente.
number_int
 number_int number

O número da fatura convertido em um valor inteiro.
status
 status string

O status da fatura. O status inicial sempre será conceito.
expiration_date
 expiration_date string

A data de validade da fatura. É definido quando a fatura é definida como aberta.
opened_at
 opened_at string

A data em que o status da fatura foi alterado para abrir.
descrição
 description string

Descrição legível humana da fatura.
account_name
 account_name string

O nome da conta que está pagando. É copiado para a fatura e, portanto, não é atualizado automaticamente se o nome da conta for alterado.
moeda
 currency string

A moeda da fatura.
total_incl
 total_incl string

O custo total da fatura, incluindo o IVA.
total_excl
 total_excl string

O custo total da fatura, excluindo o IVA.
total_open
 total_open string

O custo aberto da fatura, incluindo o IVA.
pdf_url
 pdf_url string

Url para o caminho de download da fatura no formato PDF.
xml_url
 xml_url string

Url para o caminho de download da fatura no formato UML.
funcionalidade
 feature string

Alguma descrição da fatura exibida na fatura.
nota de rodapé
 footnote string

A nota exibida na parte inferior da fatura.
invoice_items
 invoice_items array of invoice_item
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

invoice_item

Nome Caminho Tipo Description
id
 id integer

Identificador exclusivo do item da fatura.
Unidades
 units number

O número de unidades do item da fatura.
Description
 name string

O nome do item da fatura.
Preço
 unit_price string

O preço de uma única unidade.
IVA
 invoice_vat_id number

Identificador do iva da fatura.
Variante do Catálogo
 catalog_variant_id number

Identificador da variante do catálogo.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

invoice_vat

Nome Caminho Tipo Description
id
 id integer

Idenitfier exclusivo do iva da fatura.
nome
 name string

Nome do iva da fatura.
porcentagem
 percentage string

Número que representa o percentual de IVA.

catalog_variant

Nome Caminho Tipo Description
id
 id number

Identificador exclusivo da variante do catálogo
product_id
 product_id number

Identificador exclusivo do produto de catálogo
nome
 name string

O nome do curso.
cost_scheme
 cost_scheme string

Como a variante do catálogo deve ser paga por padrão.
custar
 cost string

O preço a ser pago por essa variante de catálogo.
moeda
 currency string

A moeda da variante do catálogo.
variantable_type
 variantable_type string

A moeda da fatura.
variantable_id
 variantable_id number

Identificador exclusivo do variantable.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.
Publicado
 is_published boolean

Se a categoria deve ser publicada no site.

etiqueta

Nome Caminho Tipo Description
id
 id number

Identificador exclusivo do rótulo
Nome
 name string

O nome do rótulo.
Cor
 color string

Código Hex da cor do rótulo.
Modelo
 model_type string

O tipo de modelo para o qual esse rótulo é disponibilizado.
updated_at
 updated_at string

Carimbo de data/hora da última atualização.
criado_em
 created_at string

Carimbo de data/hora da criação.

webhook_payload

Nome Caminho Tipo Description
Educador
 educator string

Lesma do educador.
evento
 event string

Tipo de evento que disparou o webhook.
entity_type
 entity_type string

Tipo do modelo que disparou o webhook.
entity_id
 entity_id number

Identificador exclusivo do modelo que disparou o webhook.
id_do_inquilino
 tenant_id string

UUID do educador.