StaffCircle (versão prévia)
O StaffCircle é uma plataforma de sucesso de funcionários que combina a cultura da empresa com o Gerenciamento de Desempenho, a fim de criar equipes de alto desempenho mesmo em ambientes de trabalho distribuídos. StafffCircle inclui Objetivo, Revisões, Valores e Comentários vinculados à sua estrutura de competência. Impulsione o engajamento e o desempenho com insights profundos.
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 | Suporte ao StaffCircle |
| URL | https://www.staffcircle.com/contact-us/ |
| support@staffcircle.com |
| Metadados do conector | |
|---|---|
| Publicador | StaffCircle |
| Site | https://www.staffcircle.com/ |
| Política de Privacidade | https://www.staffcircle.com/privacy-policy/ |
| Categorias | Comunicação; Recursos humanos |
O StaffCircle ajuda as organizações a gerenciar sua força de trabalho remota melhorando o gerenciamento de desempenho, as Comms e a Cultura. Você pode se conectar ao StaffCircle para gerenciar suas avaliações one2one, objetivos de desempenho, okrs, comentários em tempo real, prêmios e reconhecimento. Você pode executar várias ações, como criar ou atualizar objetivos de desempenho, atribuir prêmios, criar artigos e alertas, atualizar informações do usuário e muito mais.
Pré-requisitos
Para usar esse conector, você precisará ter acesso a uma conta do StaffCircle. StaffCircle é um plano de assinatura pago. Se você não tiver acesso a uma conta do StaffCircle, poderá encontrar mais detalhes aqui.
Como obter credenciais
Se você tiver acesso a uma conta do StaffCircle, já terá as credenciais necessárias para começar a usar esse conector. Ao criar uma conexão para o conector StaffCircle, você será solicitado a inserir seu nome de usuário e senha. Todas as credenciais de conta do StaffCircle podem ser usadas aqui. É importante observar que o conector será executado no contexto das credenciais fornecidas, o que inclui levar em conta as permissões de segurança. Isso significa que você deve verificar se a conta StaffCircle usada tem as permissões corretas para executar a ação que você está disparando no conector.
Introdução ao conector
Começar a usar o conector StaffCircle é fácil, você só precisa de uma conta do StaffCircle. Suas credenciais de usuário podem ser usadas para criar uma conexão com o conector StaffCircle. Uma vez concluído, você pode usar um de nossos gatilhos definidos no conector para começar a disparar fluxos de trabalho automatizados de eventos que ocorrem dentro de sua instância do StaffCircle.
Aqui estão alguns exemplos de fluxos de trabalho
- Dispare um fluxo de trabalho quando um artigo for publicado no StaffCircle e envie uma notificação sobre o artigo para um aplicativo de chat, como o Slack.
- Dispare um fluxo de trabalho quando um novo membro da equipe é adicionado ao StaffCircle e conduz um processo de integração que pode incluir comunicações como emails para o novo membro da equipe.
StaffCircle tem muitos webhooks que não são todos expostos no conector como gatilhos. Se você não conseguir encontrar um gatilho para atender às suas necessidades, considere exibir nossos webhooks. Nossos webhooks podem ser encontrados no aplicativo Web StaffCircle na seção de integração das configurações. Você pode usar o gatilho de fluxo "Quando uma solicitação HTTP é recebida" para gerar uma URL que pode ser fornecida ao webhook StaffCircle para disparar um fluxo de trabalho.
Um exemplo desse fluxo de trabalho seria
- Quando uma solicitação de feriado é feita para um membro da equipe criar um evento do Outlook Calendar.
O StaffCircle disponibilizou uma coleção de ações para ajudar a melhorar a comunicação e o gerenciamento objetivo em uma empresa. Ações como "Criar um novo alerta" podem ser usadas para disparar o envio de mensagens em vários canais aos quais o StaffCircle dá suporte, como email, sms, MS Teams, No Aplicativo e Notificações por Push. Isso ajuda a manter suas equipes informadas sobre eventos importantes que ocorrem em outros aplicativos.
As ações objective podem ser usadas para automatizar o acompanhamento de KPIs. À medida que os eventos ocorrem em outros aplicativos, por exemplo, ganhando uma oportunidade, você pode atualizar seus objetivos definidos em StaffCircle com o valor da oferta.
O StaffCircle forneceu ações de conveniência, como "Obter Pessoa por email" para ajudar a facilitar a vinculação dos membros da equipe a outras ações, como "Criar uma nova tarefa"
Support
Se você estiver enfrentando dificuldades para configurar o conector StaffCircle ou precisar de funcionalidade para atender às suas necessidades comerciais, entre em contato conosco em support@staffcircle.com
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar uma pontuação de objetivo |
Atualiza um objetivo com uma nova pontuação e uma descrição |
| Criar um novo alerta |
Cria um novo alerta que pode ser distribuído aos usuários do StaffCircle por meio de vários canais de comunicação |
| Criar um novo artigo |
Cria um novo artigo que pode ser distribuído aos usuários do StaffCircle por meio de vários canais de comunicação |
| Criar um novo objetivo |
Cria um novo objetivo |
| Criar um novo objetivo por modelo |
Cria um novo objetivo usando um modelo de objetivo |
| Criar uma nova pessoa |
Cria uma pessoa |
| Criar uma nova tarefa |
Cria uma nova tarefa e a atribui a um usuário |
| Obter Pessoa por email |
Tenta localizar um registro de pessoa por email |
| Pesquisar objetivos |
Pesquisar objetivos |
Atualizar uma pontuação de objetivo
Atualiza um objetivo com uma nova pontuação e uma descrição
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objetivo
|
objectiveId | True | string |
O objetivo para o qual a pontuação de progresso deve ser atualizada |
|
Value
|
value | True | double |
O progresso total atual |
|
É Incremento
|
isIncrement | boolean |
Se false, o valor passado será o valor atual do objetivo. Se for true, o valor deverá ser adicionado ao total existente |
|
|
Description
|
description | True | string |
Uma breve descrição do progresso feito |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador do registro de progresso objetivo |
Criar um novo alerta
Cria um novo alerta que pode ser distribuído aos usuários do StaffCircle por meio de vários canais de comunicação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Title
|
title | True | string |
O título do alerta |
|
Priority
|
priority | True | string |
Qual é a prioridade do alerta |
|
Resumo
|
summary | string |
O conteúdo principal do alerta |
|
|
Enviar para todos
|
everyone | boolean |
Se esse alerta for enviado a todos os usuários da empresa |
|
|
Enviar para marcas de departamento
|
departmentTags | string |
Uma lista separada por vírgulas de marcas de departamento que devem receber o alerta. Não use se Enviar para Todos estiver definido como true |
|
|
Enviar para marcas de pessoas
|
peopleTags | string |
Uma lista separada por vírgulas de marcas de pessoas que devem receber o alerta. Não use se Enviar para Todos estiver definido como true |
|
|
Enviar para marcas de grupo
|
groupTags | string |
Uma lista separada por vírgulas de marcas de grupo que devem receber o alerta. Não use se Enviar para Todos estiver definido como true |
|
|
Enviar para marcas de site
|
siteTags | string |
Uma lista separada por vírgulas de marcas de site que devem receber o alerta. Não use se Enviar para Todos estiver definido como true |
|
|
Enviar notificações por push
|
push | boolean |
Se os usuários devem ser notificados por push por meio de notificações por push |
|
|
Enviar notificações por SMS
|
sms | boolean |
Se os usuários devem ser notificados por meio de notificações por SMS |
|
|
Enviar notificação por email
|
boolean |
Se deve enviar a notificação de alerta por email |
||
|
Enviar notificação do aplicativo
|
inApp | boolean |
Se os usuários devem ser notificados por meio de notificações de aplicativo |
|
|
Enviar notificação do Microsoft Teams
|
teams | boolean |
Se os usuários devem ser notificados por meio de notificações do Microsoft Teams |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador do alerta |
Criar um novo artigo
Cria um novo artigo que pode ser distribuído aos usuários do StaffCircle por meio de vários canais de comunicação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Title
|
title | True | string |
O título do artigo. Comprimento Máximo de 250 caracteres |
|
Priority
|
priority | True | string |
Qual é a prioridade do artigo |
|
Tipo de artigo
|
articleType | True | string |
O tipo de artigo que deve ser criado |
|
Conteúdo HTML
|
htmlContent | True | string |
O conteúdo HTML principal do artigo. |
|
URL da Imagem do Artigo
|
mainImageUrl | string |
A URL para uma imagem que será usada como a imagem principal dos artigos no feed. |
|
|
Resumo
|
summary | string |
Um resumo do artigo. Padrão para os primeiros 500 caracteres de conteúdo Html se não for fornecido. |
|
|
Etiqueta
|
tag | True | string |
A marca associada ao artigo. Caracteres máximos 250 |
|
ID do canal
|
channelId | integer |
Em qual canal o artigo será publicado. Se deixado em branco, será definido como o feed padrão |
|
|
Enviar notificações por push
|
push | boolean |
Se os usuários devem notificar sobre o artigo por push de notificações |
|
|
Enviar notificações por SMS
|
sms | boolean |
Se os usuários devem notificar sobre o artigo por notificações por SMS |
|
|
Enviar notificações por email
|
boolean |
Se você deve notificar os usuários sobre o artigo por notificações por email |
||
|
Enviar notificações do aplicativo
|
inApp | boolean |
Se você deve notificar os usuários sobre o artigo por meio de notificações de aplicativo |
|
|
Enviar notificações do Teams
|
teams | boolean |
Se os usuários devem notificar sobre o artigo por notificações do Microsoft Teams |
|
|
Permitir Curtidas
|
allowLikes | boolean |
Os usuários podem gostar do artigo. True padrão |
|
|
Permitir Comentários
|
allowComments | boolean |
Os usuários podem comentar o artigo. Padrão verdadeiro. |
|
|
Permitir imagens em comentários
|
allowImagesInComments | boolean |
Se as imagens são permitidas em comentários |
|
|
Fixar a partir da data
|
pinFromDate | date-time |
Caso o artigo seja fixado. Nesse caso, dê uma data. Obrigatório se as horas de duração do pino forem fornecidas |
|
|
Horas de duração do pin
|
pinDurationHours | integer |
Quantas horas após a Data de Fixação deve o artigo permanecer fixado. Obrigatório se a data de fixação for fornecida. |
|
|
Hora da data agendada da publicação
|
scheduledDateTime | string |
Se este artigo for agendado para publicação no futuro. |
|
|
Publicar imediatamente
|
publishImmediately | boolean |
Se este artigo for publicado imediatamente |
|
|
Publicar ID do Usuário
|
publishAsUserId | integer |
Caso contrário, o usuário que está fazendo a chamada à API da qual o usuário deve fazer isso em nome. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador do artigo que foi criado |
Criar um novo objetivo
Cria um novo objetivo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Competência
|
categoryId | True | integer |
A competência de objetivo vinculado |
|
Title
|
title | True | string |
O nome do novo objetivo. |
|
Description
|
description | True | string |
A descrição do novo objetivo. |
|
Data de Início
|
startDate | True | date-time |
De quando o objetivo está sendo medido |
|
Data de Término
|
endDate | True | date-time |
A data limite para o objetivo |
|
Tipo de valor
|
valueType | True | string |
Define como o objetivo é medido |
|
Etiqueta
|
tag | string |
Uma marca de texto, para uso em pesquisas e relatórios. |
|
|
Email do Gerenciador
|
managerEmail | string |
O email do gerente responsável por acompanhar o objetivo. O padrão é automaticamente para o gerente de Pessoas ou Departamentos. Obrigatório se a Pessoa ou Departamento não tiver nenhum gerente ou se o objetivo for um objetivo da empresa. Usado se a ID do Gerenciador não for fornecida |
|
|
ID do gerente
|
managerId | integer |
O gerente responsável por acompanhar o objetivo. O padrão é automaticamente para o gerente de Pessoas ou Departamentos. Obrigatório se a Pessoa ou Departamento não tiver nenhum gerente ou se o objetivo for um objetivo da empresa. Usado se o Email do Gerenciador não for fornecido |
|
|
Email de pessoa
|
personEmail | string |
O endereço de email da pessoa para quem o objetivo é. Necessário para criar um objetivo pessoal. Se nenhum Departamento ou Pessoa for fornecido, o objetivo será considerado um objetivo da empresa |
|
|
ID da pessoa
|
personId | integer |
A ID da pessoa para a qual o objetivo é. Necessário para criar um objetivo pessoal. Se nenhum Departamento ou Pessoa for fornecido, o objetivo será considerado um objetivo da empresa |
|
|
Nome do departamento
|
departmentName | string |
O nome do departamento para o qual o objetivo é. Necessário para criar um objetivo departamental. Se nenhum Departamento ou Pessoa for fornecido, o objetivo será considerado um objetivo da empresa |
|
|
ID do departamento
|
departmentId | integer |
A ID do departamento para quem o objetivo é. Necessário para criar um objetivo departamental. Se nenhum Departamento ou Pessoa for fornecido, o objetivo será considerado um objetivo da empresa |
|
|
ID do Objetivo da Empresa
|
companyObjectiveId | integer |
Um link opcional para um objetivo da empresa ao qual o objetivo recém-criado está relacionado |
|
|
ID do objetivo do departamento
|
departmentObjectiveId | integer |
Um link opcional para um objetivo departamental ao qual o objetivo recém-criado está relacionado |
|
|
Valor inicial
|
startValue | double |
Define como o objetivo é medido |
|
|
Meta
|
target | double |
O valor de destino a ser atingido para que o objetivo seja concluído com êxito |
|
|
Permitir Adicionar Progresso
|
allowAddProgress | boolean |
Se true permitir que uma pessoa adicione progresso por conta própria, caso contrário, somente o gerenciador especificado poderá atualizar o objetivo. Padrão: false. |
|
|
Recur Type
|
recurType | string |
Se fornecido, o objetivo será recorrente. Define a unidade de tempo para recorrência. |
|
|
Intervalo recur
|
recurInterval | integer |
Quantos dias/semanas/meses/anos o objetivo se repetirá. Obrigatório se o objetivo se repetir. |
|
|
Progresso Cumulativo
|
cumulativeProgress | boolean |
Especifica se ao adicionar o progresso do progresso do front-end StaffCircle é adicionado como um valor incremental. |
|
|
Enviar notificação por push
|
push | boolean |
Envia notificações por push. |
|
|
Enviar notificação por SMS
|
sms | boolean |
Enviar notificações por SMS |
|
|
Enviar notificação por email
|
boolean |
Envia atualizações de email |
||
|
Enviar notificação do Teams
|
teams | boolean |
Envia atualizações por meio do Microsoft Teams se a integração com o Teams estiver habilitada |
|
|
Enviar notificação do aplicativo
|
inApp | boolean |
Envia notificações do InApp |
|
|
Permite Curtidas
|
allowLikes | boolean |
Permitir que os usuários gostem de comentários sobre o objetivo |
|
|
Permitir Comentários
|
allowComments | boolean |
Permitir comentários sobre o objetivo |
|
|
Permitir imagens em comentários
|
allowImagesInComments | boolean |
Todas as imagens a serem anexadas aos comentários. |
|
|
Permitir Documentos
|
allowDocuments | boolean |
Permitir que documentos sejam anexados a comentários |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do objetivo
|
id | integer |
O identificador de objetivo |
Criar um novo objetivo por modelo
Cria um novo objetivo usando um modelo de objetivo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Modelo de objetivo
|
objectiveTemplateId | True | integer |
Cria um novo objetivo com base em um modelo de objetivo |
|
Data de Início
|
startDate | True | date-time |
De quando o objetivo está sendo medido |
|
Data de Término
|
endDate | True | date-time |
A data limite para o objetivo |
|
Email de pessoa
|
personEmail | string |
O endereço de email da pessoa para quem o objetivo é. Necessário para criar um objetivo pessoal. Se nenhum Departamento ou Pessoa for fornecido, o objetivo será considerado um objetivo da empresa |
|
|
ID da pessoa
|
personId | integer |
A ID da pessoa para a qual o objetivo é. Necessário para criar um objetivo pessoal. Se nenhum Departamento ou Pessoa for fornecido, o objetivo será considerado um objetivo da empresa |
|
|
Nome do departamento
|
departmentName | string |
O nome do departamento para o qual o objetivo é. Necessário para criar um objetivo departamental. Se nenhum Departamento ou Pessoa for fornecido, o objetivo será considerado um objetivo da empresa |
|
|
ID do departamento
|
departmentId | integer |
A ID do departamento para quem o objetivo é. Necessário para criar um objetivo departamental. Se nenhum Departamento ou Pessoa for fornecido, o objetivo será considerado um objetivo da empresa |
|
|
Email do Gerenciador
|
managerEmail | string |
O email do gerente responsável por acompanhar o objetivo. O padrão é automaticamente para o gerente de Pessoas ou Departamentos. Obrigatório se a Pessoa ou Departamento não tiver nenhum gerente ou se o objetivo for um objetivo da empresa. Usado se a ID do Gerenciador não for fornecida |
|
|
Title
|
title | string |
Substitui o nome do novo objetivo. |
|
|
Description
|
description | string |
Substitui a descrição do novo objetivo. |
|
|
ID do gerente
|
managerId | integer |
O gerente responsável por acompanhar o objetivo. O padrão é automaticamente para o gerente de Pessoas ou Departamentos. Obrigatório se a Pessoa ou Departamento não tiver nenhum gerente ou se o objetivo for um objetivo da empresa. Usado se o Email do Gerenciador não for fornecido |
|
|
ID do Objetivo da Empresa
|
companyObjectiveId | integer |
Um link opcional para um objetivo da empresa ao qual o objetivo recém-criado está relacionado |
|
|
ID do objetivo do departamento
|
departmentObjectiveId | integer |
Um link opcional para um objetivo departamental ao qual o objetivo recém-criado está relacionado |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do objetivo
|
id | integer |
O identificador do objetivo criado |
Criar uma nova pessoa
Cria uma pessoa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Primeiro Nome
|
firstName | True | string |
O nome da pessoa |
|
Segundo Nome
|
secondName | True | string |
O segundo nome da pessoa |
|
Email
|
True | string |
O endereço de email de trabalho da pessoa |
|
|
Telemóvel
|
mobile | True | string |
O número de telefone celular da pessoa |
|
Data de nascimento
|
dateOfBirth | True | date |
Data de nascimento da pessoa |
|
Data de Início
|
startDate | True | string |
Quando o emprego da pessoa começou |
|
Linha de endereço 1
|
addressLine1 | string |
A primeira linha do endereço residencial da pessoa |
|
|
Linha de endereço 2
|
addressLine2 | string |
A segunda linha do endereço residencial da pessoa |
|
|
Cidade
|
town | string |
A cidade de residência da pessoa |
|
|
Cp
|
postCode | string |
O código postal da pessoa |
|
|
Nome do Condado
|
countyName | string |
O condado de residência da pessoa |
|
|
Nome do país
|
countryName | string |
O país de residência da pessoa |
|
|
Nome do título
|
titleName | string |
O título da pessoa |
|
|
Nome do Meio
|
middleName | string |
O nome do meio da pessoa |
|
|
Email Pessoal
|
homeEmail | string |
O endereço de email pessoal da pessoa |
|
|
Telefone Residencial
|
homeTelephone | string |
O número de telefone da pessoa em casa |
|
|
Etiqueta
|
tag | string |
A marca que pode ser usada para referenciar a pessoa em toda a plataforma StaffCircle |
|
|
Email do Gerenciador
|
managerEmail | string |
O endereço de email do gerente da pessoa. Isso pode ser usado para vincular um gerente a uma pessoa |
|
|
Nome do departamento
|
departmentName | string |
O nome do departamento ao qual a pessoa pertence |
|
|
Nome da Função
|
roleName | string |
O papel da pessoa. Isso pode ser usado para vincular uma função a uma pessoa |
|
|
Conhecido como
|
knownAs | string |
O nome que a pessoa prefere ser conhecida como |
|
|
URL da Imagem de Perfil
|
avatarURL | string |
A imagem do perfil da pessoa |
|
|
ID do título
|
titleId | integer |
O título da pessoa |
|
|
ID do condado
|
countyId | integer |
O condado de residência da pessoa |
|
|
ID do país
|
countryId | integer |
O país de residência da pessoa |
|
|
ID de gênero
|
genderId | integer |
Identificador de gênero da pessoa |
|
|
ID de nacionalidade
|
nationalityId | integer |
A nacionalidade da pessoa |
|
|
ID da etnia
|
ethnicityId | integer |
A etnia da pessoa |
|
|
ID do Estado Civil
|
maritalStatusId | integer |
Estado Civil da pessoa |
|
|
ID do gerente
|
managerId | integer |
O identificador do gerente da pessoa (somente a ID do gerenciador ou o email do gerente podem ser inseridos) |
|
|
ID do departamento
|
departmentId | integer |
O identificador do departamento da pessoa (somente a ID do departamento ou o nome do departamento pode ser inserido) |
|
|
ID de Função
|
roleId | integer |
Identificador de função de emprego da pessoa (somente a ID da função ou o nome da função podem ser inseridos) |
|
|
ID do Site
|
mainSiteId | integer |
O identificador do site ao qual a pessoa pertence |
|
|
Consentimento de contato de emergência
|
emergencyContactConsent | boolean |
Se o contato de emergência deu consentimento para salvar seus detalhes |
|
|
Nome do contato de emergência
|
emergencyContactName | string |
O nome do contato de emergência da pessoa |
|
|
ID de relação de contato de emergência
|
emergencyRelationshipId | integer |
A relação entre o contato de emergência e a pessoa |
|
|
Telefone de contato de emergência
|
emergencyContactTelephone | string |
O número de telefone do contato de emergência da pessoa |
|
|
Endereço de emergência
|
emergencyAddress | string |
O endereço de emergência das pessoas |
|
|
Nome do próximo de parentes
|
nextOfKinName | string |
O nome dos parentes mais próximos da pessoa |
|
|
ID da relação Next Of Kin
|
nextOfKinRelationshipId | integer |
A relação entre os parentes mais próximos e a pessoa |
|
|
Telefone próximo de kin
|
nextOfKinTelephone | string |
O número de telefone mais próximo da pessoa |
|
|
Código de discagem
|
dialingCode | string |
Código de discagem internacional para o número de telefone da pessoa |
|
|
Extensão de Trabalho
|
workExtension | string |
O número da extensão de trabalho da pessoa |
|
|
Telefone comercial
|
telephone | string |
O número de telefone do trabalho da pessoa |
|
|
Personal Mobile
|
personalMobile | string |
O número de celular pessoal da pessoa |
|
|
Status ID
|
statusId | integer |
Status da conta StaffCircle da pessoa |
|
|
ID do tipo de emprego
|
employmentTypeId | integer |
O tipo de emprego da pessoa |
|
|
ID do tipo de contrato
|
contractTypeId | integer |
O contrato da pessoa |
|
|
Expiração do contrato
|
contractExpiry | date |
A data em que o contrato de trabalho do povo expira |
|
|
Status do Emprego
|
employmentStatusId | integer |
O status de emprego da pessoa |
|
|
Status do Emprego Secundário
|
secondaryEmploymentStatusId | integer |
O status de emprego secundário vinculado |
|
|
Notas de emprego
|
employmentNotes | string |
Notas de emprego sobre a pessoa |
|
|
Notas médicas
|
medicalNotes | string |
Quaisquer notas médicas importantes associadas à pessoa |
|
|
Os dados pessoais estão habilitados
|
isPersonalDataEnabled | boolean |
Se os dados pessoais estão habilitados ou não |
|
|
Os dados de contato estão habilitados
|
isContactDataEnabled | boolean |
Se os dados de contato estão habilitados ou não |
|
|
Fuso horário
|
timeZone | string |
O fuso horário em que a pessoa vive |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da pessoa
|
id | integer |
O identificador da pessoa |
Criar uma nova tarefa
Cria uma nova tarefa e a atribui a um usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Title
|
title | True | string |
O título da tarefa |
|
ID de prioridade
|
priorityId | integer |
Prioridade da tarefa. Obrigatório se não for derivado do Grupo de Tarefas |
|
|
Description
|
description | string |
Descrição dada à tarefa |
|
|
Planilha
|
formId | True | integer |
A planilha usada na tarefa |
|
Data de vencimento
|
dueDate | date-time |
Data em que a tarefa deve ser concluída |
|
|
Atribuído à ID
|
assignedToId | integer |
A quem é a tarefa atribuída. Não pode ser usado se passar Atribuído para Email |
|
|
ID do gerente
|
managerId | integer |
Quem está gerenciando a tarefa. Não pode ser usado se passar email do gerenciador |
|
|
ID do Grupo de Tarefas
|
taskGroupId | True | integer |
O grupo de tarefas ao qual a tarefa é atribuída |
|
Atribuído ao email
|
assignedToEmail | string |
Email ao qual a tarefa é atribuída. Não será possível usar se passar a ID Atribuída a |
|
|
Email do Gerenciador
|
managerEmail | string |
Email de quem está gerenciando a tarefa. Não será possível atribuir se a ID do Gerenciador for passada |
|
|
ID do intervalo de tarefas
|
taskIntervalId | integer |
ID do intervalo de tarefas. Obrigatório se a tarefa for recursada |
|
|
Enviar notificações por push
|
push | boolean |
Envia notificações por push sobre a tarefa |
|
|
Enviar notificações por SMS
|
sms | boolean |
Envia notificações por sms sobre a tarefa |
|
|
Enviar notificações por email
|
boolean |
Envia notificações por email sobre a tarefa |
||
|
Enviar notificações do Microsoft Teams
|
teams | boolean |
Envia notificações do Microsoft Teams sobre a tarefa |
|
|
Enviar notificações do aplicativo
|
inApp | boolean |
Envia notificações do aplicativo sobre a tarefa |
|
|
Permitir Curtidas
|
allowLikes | boolean |
Permitir que os usuários gostem de comentários na tarefa |
|
|
Permitir Comentários
|
allowComments | boolean |
Permitir comentários sobre a tarefa |
|
|
Permitir imagens em comentários
|
allowImagesInComments | boolean |
Todas as imagens a serem anexadas aos comentários |
|
|
Permitir Documentos
|
allowDocuments | boolean |
Permitir que documentos sejam anexados a comentários |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador da tarefa |
Obter Pessoa por email
Tenta localizar um registro de pessoa por email
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar email
|
SearchEmail | True | string |
Pesquisar por email |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
ID
|
results.id | integer |
A ID da pessoa |
|
Primeiro Nome
|
results.firstName | string |
O nome da pessoa |
|
Surname
|
results.secondName | string |
O sobrenome da pessoa |
|
Conhecido como
|
results.knownAs | string |
Qual nome a pessoa gosta de ser conhecida como |
|
Email
|
results.email | string |
O endereço de email da pessoa |
|
Código de discagem
|
results.dialingCode | string |
O código de discagem para o número de telefone da pessoa |
|
Número do Celular
|
results.mobile | string |
O número de telefone celular da pessoa |
|
ID do Site Principal
|
results.mainSite.id | integer |
A ID do site principal ao qual a pessoa está associada |
|
Nome do Site Principal
|
results.mainSite.name | string |
O nome fornecido ao site principal |
|
descrição
|
results.mainSite.description | string |
descrição |
|
gerente
|
results.mainSite.manager | string |
gerente |
|
ID do gerente
|
results.manager.id | integer |
A ID dos mangers |
|
Nome dos gerentes
|
results.manager.firstName | string |
O nome dos gerentes |
|
Segundo Nome dos Gerentes
|
results.manager.secondName | string |
O segundo nome dos gerentes |
|
Active
|
results.active | boolean |
se a pessoa está ativa ou não no momento |
|
ID do departamento
|
results.department.id | integer |
A ID do departamento associado à pessoa |
|
Nome do departamento
|
results.department.name | string |
O nome dado ao departamento |
|
Etiqueta
|
results.tag | string |
A marca que ressente a pessoa |
|
ID de Função
|
results.role.id | integer |
A ID da função |
|
Nome da Função
|
results.role.name | string |
Nome da Função |
|
Imagem de perfil
|
results.avatarURL | string |
A URL para a imagem de perfil da pessoa |
|
Status ID
|
results.status.id | integer |
A ID do status do registro |
|
Nome do Status
|
results.status.name | string |
O nome do status do registro |
|
ID de Status da Pessoa
|
results.personStatus.id | integer |
A ID de status da pessoa |
|
Nome do status da pessoa
|
results.personStatus.name | string |
O nome do status da pessoa |
|
Data de Início
|
results.startDate | string |
Quando a pessoa começou a trabalhar na organização |
Pesquisar objetivos
Pesquisar objetivos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Título da Pesquisa
|
SearchTitle | string |
Correspondência de cadeia de caracteres solta para pesquisa com base no título |
|
|
Email de pessoa
|
PersonEmail | string |
O email da pessoa à qual o objetivo é atribuído |
|
|
Etiqueta
|
Tag | string |
A marca alocada para o objetivo |
|
|
Fechado
|
Closed | string |
Se o objetivo for fechado. True se fechado de outra forma false |
|
|
Tipo de objetivo
|
ObjectiveType | string |
O tipo de objetivo |
|
|
De
|
From | date-time |
O objetivo está ativo a partir deste momento |
|
|
Para
|
To | date-time |
O objetivo está ativo a partir deste momento |
|
|
Ativo em
|
ActiveAt | date-time |
O objetivo está ativo neste momento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
ID do objetivo
|
results.id | integer |
O identificador de objetivo |
|
Title
|
results.title | string |
O título dado ao objetivo |
|
Description
|
results.description | string |
A descrição dada ao objetivo |
|
Etiqueta
|
results.tag | string |
A marca associada ao objetivo |
|
Tipo de objetivo
|
results.objectiveType | string |
O tipo de objetivo |
|
Fechado
|
results.closed | boolean |
Se o Objetivo está fechado |
|
Motivo Fechado
|
results.closedReason | string |
O motivo pelo qual o objetivo foi fechado |
|
ID da pessoa
|
results.person.id | integer |
O identificador da pessoa para a qual o objetivo é |
|
Nome da pessoa
|
results.person.firstName | string |
O nome da pessoa para a qual o objetivo é |
|
Nome da família da pessoa
|
results.person.secondName | string |
O nome da família da pessoa do objetivo é para |
|
ID do gerente
|
results.manager.id | integer |
Identificador do gerente |
|
Nome do gerente
|
results.manager.firstName | string |
O nome do gerente |
|
Nome da família do gerente
|
results.manager.secondName | string |
O nome da família do gerente |
|
Criado por ID de pessoa
|
results.createdBy.id | integer |
O identificador da pessoa que criou o objetivo |
|
Nome criado por pessoa
|
results.createdBy.firstName | string |
O nome da pessoa que criou o objetivo |
|
Criado por nome de família de pessoa
|
results.createdBy.secondName | string |
O nome da família da pessoa que criou o objetivo |
|
ID do departamento
|
results.department.id | integer |
O identificador do departamento vinculado ao objetivo |
|
Nome do departamento
|
results.department.name | string |
O nome do departamento vinculado ao objetivo |
|
ID do objetivo do departamento
|
results.departmentObjective.id | integer |
o identificador do objetivo do departamento |
|
Título do objetivo do departamento
|
results.departmentObjective.title | string |
O título do objetivo do departamento |
|
Descrição do objetivo do departamento
|
results.departmentObjective.description | string |
Descrição do objetivo do departamento |
|
ID do Objetivo da Empresa
|
results.companyObjective.id | integer |
O identificador de objetivo da empresa |
|
Título de Objetivo da Empresa
|
results.companyObjective.title | string |
O título do objetivo da empresa |
|
Descrição do objetivo da empresa
|
results.companyObjective.description | string |
A descrição do objetivo da empresa |
|
Progresso atual
|
results.currentProgress | double |
Progresso atual no objetivo |
|
Data de Início
|
results.startDate | string |
De quando o objetivo está sendo medido |
|
Data de Término
|
results.endDate | string |
A data limite para o objetivo |
Gatilhos
| quando um novo artigo é publicado |
Disparar quando um novo artigo for publicado |
| Quando um novo objetivo é adicionado |
Dispara quando um novo objetivo é adicionado |
| Quando um objetivo é atualizado |
Dispara quando um objetivo é atualizado |
| Quando uma nova ausência é adicionada |
Dispara quando uma nova ausência é adicionada |
| Quando uma nova pessoa é adicionada |
Dispara quando uma nova pessoa é adicionada |
| Quando uma nova revisão é adicionada |
Gatilhos quando uma nova revisão é adicionada |
| Quando uma nova tarefa é adicionada |
Dispara quando uma nova tarefa é adicionada |
quando um novo artigo é publicado
Disparar quando um novo artigo for publicado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | string |
nome |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL do artigo
|
subjectFrontEndUrl | string |
A URL do artigo |
|
ID
|
data.Id | integer |
O identificador do artigo |
|
Title
|
data.Title | string |
O título dado ao artigo |
|
Resumo
|
data.Summary | string |
O resumo do artigo |
|
Etiqueta
|
data.Tag | string |
A marca associada ao artigo |
|
Nome da prioridade
|
data.PriorityName | string |
A prioridade do artigo |
|
Data da criação
|
data.CreatedAt | date-time |
A data em que o artigo foi criado pela primeira vez |
|
Todos
|
data.AudienceDto.Everyone | boolean |
Se o artigo está sendo publicado para todos |
|
Pessoas
|
data.AudienceDto.Persons | array of object | |
|
Marca de Pessoa
|
data.AudienceDto.Persons.Tag | string |
Marca de Pessoa de Destino |
|
ID
|
data.AudienceDto.Persons.Id | integer |
ID da marca |
|
Sites
|
data.AudienceDto.Sites | array of object | |
|
Marca de site
|
data.AudienceDto.Sites.Tag | string |
Marca de site de destino |
|
ID
|
data.AudienceDto.Sites.Id | integer |
ID da marca |
|
Departments
|
data.AudienceDto.Departments | array of object | |
|
Marca de departamento
|
data.AudienceDto.Departments.Tag | string |
Marca de departamento de destino |
|
ID
|
data.AudienceDto.Departments.Id | integer |
ID da marca |
|
Criado por ID
|
data.CreatedByPerson.PersonId | integer |
O identificador para a pessoa que criou o artigo |
|
Criado pelo nome
|
data.CreatedByPerson.FirstName | string |
O nome da pessoa que criou o artigo |
|
Criado pelo nome da família
|
data.CreatedByPerson.FamilyName | string |
O nome da família da pessoa que criou o artigo |
|
Criado por email
|
data.CreatedByPerson.Email | string |
O endereço de email da pessoa que criou o artigo |
|
Data da modificação
|
data.ModifiedAt | date-time |
Quando o artigo foi modificado pela última vez |
|
Modificado por ID
|
data.ModifiedByPerson.PersonId | integer |
O identificador da pessoa que modificou o artigo pela última vez |
|
Modificado pelo nome
|
data.ModifiedByPerson.FirstName | string |
O nome da pessoa que modificou o artigo pela última vez |
|
Modificado pelo nome da família
|
data.ModifiedByPerson.FamilyName | string |
O nome da família da pessoa que modificou o artigo pela última vez |
|
Modificado por email
|
data.ModifiedByPerson.Email | string |
O endereço de email da pessoa que modificou o artigo pela última vez |
|
Data de publicação
|
data.PublishedDate | date-time |
Quando o artigo foi publicado |
|
Conteúdo do Artigo
|
data.ArticleContent | string |
O conteúdo HTML do artigo |
|
Texto do conteúdo do artigo
|
data.ArticleContentText | string |
O conteúdo do artigo de texto sem formatação |
|
ID da imagem principal
|
data.MainImageId | integer |
A ID de uma imagem que será usada como a imagem principal dos artigos no feed. |
Quando um novo objetivo é adicionado
Dispara quando um novo objetivo é adicionado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registro
|
subjectFrontEndUrl | string |
A URL para o registro em StaffCircle |
|
ID do objetivo
|
data.id | integer |
O identificador do objetivo |
|
Modelo de objetivo
|
data.templateId | integer |
Cria um novo objetivo com base em um modelo de objetivo |
|
ID do gerente
|
data.manager.PersonId | integer |
Identificador do gerente da pessoa |
|
Nome do gerente
|
data.manager.FirstName | string |
O nome do gerente da pessoa |
|
Nome da família do gerente
|
data.manager.FamilyName | string |
O nome da família do gerente da pessoa |
|
Email do Gerenciador
|
data.manager.Email | string |
O endereço de email do gerente da pessoa |
|
Identificador de pessoa
|
data.person.PersonId | integer |
O identificador da pessoa vinculado ao objetivo |
|
Nome da pessoa
|
data.person.FirstName | string |
O nome da pessoa vinculado ao objetivo |
|
Nome da família da pessoa
|
data.person.FamilyName | string |
O nome da família da pessoa vinculado ao objetivo |
|
Email de pessoa
|
data.person.Email | string |
O endereço de email da pessoa vinculado ao objetivo |
|
Title
|
data.title | string |
O nome do novo objetivo |
|
Description
|
data.description | string |
A descrição do novo objetivo |
|
Tipo de valor
|
data.valueType | string |
Define como o objetivo é medido |
|
Etiqueta
|
data.tag | string |
Uma marca de texto, para uso em pesquisas e relatórios |
|
Categoria
|
data.category | string |
O identificador de categoria de objetivos |
|
Data de Início
|
data.startDate | date-time |
De quando o objetivo está sendo medido |
|
Data de Término
|
data.endDate | string |
A data limite para o objetivo |
|
Data do último progresso
|
data.lastProgressDate | date-time |
A data em que houve progresso no objetivo |
|
fechado
|
data.closed | boolean |
fechado |
|
Permitir Adicionar Progresso
|
data.allowAddProgress | boolean |
Se true permitir que uma pessoa adicione o progresso por conta própria, caso contrário, somente o gerenciador especificado poderá atualizar o objetivo |
|
Notificação por push
|
data.notificationSettings.push | boolean |
Envia notificações por push. |
|
Notificação por SMS
|
data.notificationSettings.sms | boolean |
Enviar notificações por SMS |
|
Notificação por email
|
data.notificationSettings.email | boolean |
Envia atualizações de email |
|
Notificação do Teams
|
data.notificationSettings.microsoftTeams | boolean |
Envia atualizações por meio do Microsoft Teams se a integração com o Teams estiver habilitada |
|
Na Notificação do Aplicativo
|
data.notificationSettings.inApp | boolean |
Envia notificações do InApp |
|
Permite Curtidas
|
data.contentSettings.allowLikes | boolean |
Permitir que os usuários gostem de comentários sobre o objetivo |
|
Permitir Comentários
|
data.contentSettings.allowComments | boolean |
Permitir comentários sobre o objetivo |
|
Permitir imagens em comentários
|
data.contentSettings.allowImagesInComments | boolean |
Todas as imagens a serem anexadas aos comentários. |
|
Permitir Documentos
|
data.contentSettings.allowDocuments | boolean |
Permitir que documentos sejam anexados a comentários |
|
Criado em
|
data.createdAt | date-time |
Quando o objetivo for criado |
|
Criado por ID de pessoa
|
data.createdByPerson.PersonId | integer |
O identificador da pessoa que criou o objetivo |
|
Nome criado por pessoa
|
data.createdByPerson.FirstName | string |
O nome da pessoa que criou o objetivo |
|
Criado por nome de família de pessoa
|
data.createdByPerson.FamilyName | string |
O nome da família da pessoa que criou o objetivo |
|
Criado por email de pessoa
|
data.createdByPerson.Email | string |
O endereço de email da pessoa que criou o objetivo |
|
Progresso atual
|
data.currentProgress | double |
Progresso atual no objetivo |
|
Valor inicial
|
data.startValue | double |
Define como o objetivo é medido |
|
Meta
|
data.targetValue | double |
O valor de destino a ser atingido para que o objetivo seja concluído com êxito |
Quando um objetivo é atualizado
Dispara quando um objetivo é atualizado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registro
|
subjectFrontEndUrl | string |
A URL para o registro em StaffCircle |
|
ID
|
data.id | integer |
O identificador do registro de progresso objetivo |
|
ID do objetivo
|
data.objectiveId | integer |
O objetivo ao qual esse registro de progresso está associado |
|
Value
|
data.value | double |
O valor de progresso total para o objeto |
|
Description
|
data.description | string |
A descrição adicionada ao registro de progresso objetivo |
|
Data da criação
|
data.createdAt | date-time |
Quando o registro de progresso foi criado |
|
Criado por ID de pessoa
|
data.createdByPerson.PersonId | integer |
O identificador da pessoa que criou o registro de objetivo de progresso |
|
Criado pelo nome
|
data.createdByPerson.FirstName | string |
O nome da pessoa que criou o registro de progresso objetivo |
|
Criado pelo nome da família
|
data.createdByPerson.FamilyName | string |
O nome da família da pessoa que criou o registro de progresso objetivo |
|
Criado por email
|
data.createdByPerson.Email | string |
O endereço de email da pessoa que criou o registro de progresso objetivo |
|
Enviar Notificações
|
data.sendNotifications | boolean |
Indica se as notificações foram enviadas |
Quando uma nova ausência é adicionada
Dispara quando uma nova ausência é adicionada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registro
|
subjectFrontEndUrl | string |
A URL do registro em StaffCircle |
|
ID
|
data.id | integer |
O identificador da ausência |
|
ID da pessoa
|
data.requestedForPerson.PersonId | integer |
O identificador da pessoa para a qual a solicitação de ausência é |
|
Nome da pessoa
|
data.requestedForPerson.FirstName | string |
O nome da pessoa para a qual a solicitação de ausência é |
|
Nome da família da pessoa
|
data.requestedForPerson.FamilyName | string |
O nome da família da pessoa para a qual a solicitação de ausência é |
|
Email de pessoa
|
data.requestedForPerson.Email | string |
O endereço de email da pessoa para a qual a solicitação de ausência é |
|
Tipo de unidade
|
data.unitType | string |
O tipo de unidade de solicitação de ausência (Horas, Dias) |
|
Número de horas
|
data.numberOfHours | double |
O número de horas que foram solicitadas desativadas |
|
Dia Parcial
|
data.partialDay | string |
Se um dia parcial foi solicitado (Manhã, Tarde) |
|
Data de Início
|
data.start | date-time |
Quando a ausência é iniciada |
|
Data de Término
|
data.end | date-time |
Quando a ausência chegar ao fim |
|
ID do tipo
|
data.typeId | integer |
O identificador para o tipo de ausência que está sendo solicitado |
|
Tipo
|
data.type | string |
O tipo de ausência que está sendo solicitado |
|
ID do subtipo
|
data.subTypeId | integer |
O identificador para o subtipo de ausência que está sendo solicitado |
|
ID da Política
|
data.policyId | integer |
O identificador da política de ausência na qual o membro da equipe está |
|
Reason
|
data.reason | string |
O motivo da solicitação de ausência |
|
Data da criação
|
data.createdAt | date-time |
Quando a solicitação de ausência foi feita |
|
Criado por ID
|
data.createdByPerson.PersonId | integer |
O identificador da pessoa que criou a solicitação de ausência |
|
Criado pelo nome
|
data.createdByPerson.FirstName | string |
O nome da pessoa que criou a solicitação de ausência |
|
Criado pelo nome da família
|
data.createdByPerson.FamilyName | string |
O nome da família da pessoa que criou a solicitação de ausência |
|
Criado por email
|
data.createdByPerson.Email | string |
O endereço de email da pessoa que criou a solicitação de ausência |
|
Status de Aprovação
|
data.approvalDetails.status | string |
O status da aprovação (pendente, aprovada, recusada) |
|
Aprovado em
|
data.approvalDetails.approvedAt | date-time |
Quando a ausência foi aprovada |
|
Resposta de aprovação
|
data.approvalDetails.response | string |
A resposta fornecida pelo aprovador |
|
Aprovado por ID
|
data.approvalDetails.approvedByPerson.PersonId | integer |
O identificador da pessoa que aprovou a ausência |
|
Aprovado por nome
|
data.approvalDetails.approvedByPerson.FirstName | string |
O nome da pessoa que aprovou a ausência |
|
Aprovado pelo nome da família
|
data.approvalDetails.approvedByPerson.FamilyName | string |
Nome da família da pessoa que aprovou a ausência |
|
Aprovado por email
|
data.approvalDetails.approvedByPerson.Email | string |
O endereço de email da pessoa que aprovou a ausência |
|
ID do gerente
|
data.manager.PersonId | integer |
O identificador do gerente envolvido na solicitação de ausência |
|
Nome do gerente
|
data.manager.FirstName | string |
O nome do gerente envolvido na solicitação de ausência |
|
Nome da família do gerente
|
data.manager.FamilyName | string |
O nome da família do gerente envolvido na solicitação de ausência |
|
Email do Gerenciador
|
data.manager.Email | string |
O endereço de email do gerente envolvido na solicitação de ausência |
Quando uma nova pessoa é adicionada
Dispara quando uma nova pessoa é adicionada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registro
|
subjectFrontEndUrl | string |
A URL para o registro em StaffCircle |
|
ID da pessoa
|
data.id | integer |
O identificador que representa a pessoa |
|
Primeiro Nome
|
data.givenName | string |
O nome da pessoa |
|
Nome do Meio
|
data.middleName | string |
O nome do meio da pessoa |
|
Sobrenome
|
data.familyName | string |
O nome da família da pessoa |
|
conhecido como
|
data.knownAs | string |
Qual nome a pessoa gosta de ser conhecida como |
|
Data de nascimento
|
data.dateOfBirth | date |
Data de nascimento da pessoa |
|
Email Pessoal
|
data.contactDetails.personalEmail | string |
O endereço de email pessoal da pessoa |
|
Email de trabalho
|
data.contactDetails.workEmail | string |
O endereço de email de trabalho da pessoa |
|
Work Mobile
|
data.contactDetails.workMobile | string |
O número móvel de trabalho da pessoa |
|
Personal Mobile
|
data.contactDetails.personalMobile | string |
O número de celular pessoal da pessoa |
|
Telefone Residencial
|
data.contactDetails.homeTelephone | string |
O número de telefone da pessoa em casa |
|
Telefone comercial
|
data.contactDetails.workTelephone | string |
O número de telefone do trabalho da pessoa |
|
Telefone comercial
|
data.contactDetails.workExtension | string |
O número da extensão de trabalho da pessoa |
|
Linha de endereço 1
|
data.address.addressLine1 | string |
A primeira linha do endereço residencial da pessoa |
|
Linha de endereço 2
|
data.address.addressLine2 | string |
A primeira linha do endereço residencial da pessoa |
|
Cidade
|
data.address.town | string |
A cidade de residência da pessoa |
|
Cp
|
data.address.postCode | string |
O código postal da pessoa |
|
Nome do contato de emergência
|
data.emergencyContact.emergencyContactName | string |
O nome do contato de emergência da pessoa |
|
Telefone de contato de emergência
|
data.emergencyContact.emergencyContactTelephone | string |
O número de telefone do contato de emergência da pessoa |
|
ID de relação de contato de emergência
|
data.emergencyContact.emergencyRelationshipId | integer |
A relação entre o contato de emergência e a pessoa |
|
Consentimento de contato de emergência
|
data.emergencyContact.emergencyContactConsent | boolean |
Se o contato de emergência deu consentimento para salvar seus detalhes |
|
Endereço de contato de emergência
|
data.emergencyContact.emergencyAddress | string |
O endereço de contato de emergência das pessoas |
|
Notas médicas
|
data.emergencyContact.emergencyMedicalNotes | string |
Quaisquer notas médicas importantes associadas à pessoa |
|
Próximo de Kin Name
|
data.nextOfKin.Name | string |
O parente mais próximo da pessoa |
|
Telefone Próximo de Kin
|
data.nextOfKin.Telephone | string |
O número de telefone mais próximo da pessoa |
|
ID da relação Next of Kin
|
data.nextOfKin.RelationshipId | string |
A relação entre os parentes mais próximos e a pessoa |
|
Notas de emprego
|
data.employeeDetails.employmentNotes | string |
Notas de emprego sobre a pessoa |
|
Etiqueta
|
data.employeeDetails.tag | string |
A marca que pode ser usada para referenciar a pessoa em toda a plataforma StaffCircle |
|
Data de Início
|
data.employeeDetails.startDate | string |
Quando o emprego da pessoa começou |
|
ID do Site
|
data.employeeDetails.siteId | integer |
O identificador do site ao qual a pessoa pertence |
|
ID do grupo
|
data.employeeDetails.groupId | integer |
O grupo ao qual a pessoa pertence |
|
ID do departamento
|
data.employeeDetails.departmentId | integer |
O departamento que a pessoa pertence |
|
ID do gerente
|
data.employeeDetails.manager.PersonId | integer |
O identificador do gerente do parson |
|
Nome do gerente
|
data.employeeDetails.manager.FirstName | string |
O nome do gerente da pessoa |
|
Nome da família do gerente
|
data.employeeDetails.manager.FamilyName | string |
O nome da família do gerente da pessoa |
|
Email do Gerenciador
|
data.employeeDetails.manager.Email | string |
O endereço de email do gerente da pessoa |
|
Status da conta
|
data.accountStatus | integer |
Status da conta StaffCircle da pessoa |
Quando uma nova revisão é adicionada
Gatilhos quando uma nova revisão é adicionada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registro
|
subjectFrontEndUrl | string |
A URL do registro em StaffCircle |
|
ID
|
data.id | integer |
O identificador de revisão |
|
ID da revisão anterior
|
data.previousReviewId | integer |
O identificador da revisão anterior para este revisor |
|
ID do gerente
|
data.manager.PersonId | integer |
O identificador do gerente associado à revisão |
|
Nome do gerente
|
data.manager.FirstName | string |
O primeiro nome do gerente associado à revisão |
|
Nome da família do gerente
|
data.manager.FamilyName | string |
O nome da família do gerente associado à revisão |
|
Email do Gerenciador
|
data.manager.Email | string |
O endereço de email do gerente associado à revisão |
|
internalReviewerPersonIds
|
data.internalReviewerPersonIds | array of integer |
internalReviewerPersonIds |
|
ID do revisor
|
data.person.PersonId | integer |
O identificador do revisor |
|
Nome do revisor
|
data.person.FirstName | string |
O primeiro nome do revisor |
|
Nome da família do revisor
|
data.person.FamilyName | string |
O nome da família do revisor |
|
Email do Revisor
|
data.person.Email | string |
O endereço de email do revisor |
|
Title
|
data.title | string |
O título dado à revisão |
|
Description
|
data.description | string |
A descrição fornecida à revisão |
|
Tipo de Revisão
|
data.reviewType | string |
O tipo de revisão |
|
Due On
|
data.dueOn | date-time |
Quando a revisão for concluída |
|
attachedDocumentIds
|
data.attachedDocumentIds | array of integer |
attachedDocumentIds |
|
linkedObjectives
|
data.linkedObjectives | array of integer |
linkedObjectives |
|
ID do modelo de avaliação
|
data.appraisalSummary.personAppraisalTemplateId | integer |
O modelo de avaliação usado para criar a avaliação |
|
Pontuação atual
|
data.scores.currentScore | double |
A pontuação atual de revisões |
|
Data da criação
|
data.createdAt | date-time |
Quando a revisão foi criada |
|
Criado por ID
|
data.createdByPerson.PersonId | integer |
O Identificador da pessoa que criou a revisão |
|
Criado pelo nome
|
data.createdByPerson.FirstName | string |
O nome da pessoa que criou a revisão |
|
Criado pelo nome da família
|
data.createdByPerson.FamilyName | string |
O nome da família da pessoa que criou a revisão |
|
Criado por email
|
data.createdByPerson.Email | string |
O endereço de email da pessoa que criou a revisão |
|
Permitir Curtidas
|
data.contentSettings.allowLikes | boolean |
Se os likes são permitidos |
|
Permitir Comentários
|
data.contentSettings.allowComments | boolean |
Se os comentários são permitidos na revisão |
|
Permitir imagens em comentários
|
data.contentSettings.allowImagesInComments | boolean |
Se as imagens são permitidas em comentários |
|
Permitir Documentos
|
data.contentSettings.allowDocuments | boolean |
Se os documentos podem ser anexados à revisão |
|
Notificações por Push
|
data.notificationSettings.push | boolean |
Se as notificações por push devem ser enviadas por push |
|
Notificações por SMS
|
data.notificationSettings.sms | boolean |
Se enviar notificações por sms |
|
Notificação por email
|
data.notificationSettings.email | boolean |
Se enviar notificações por email |
|
Notificações do Microsoft Teams
|
data.notificationSettings.microsoftTeams | boolean |
Se deseja enviar notificações do Microsoft Teams |
|
Em Notificações de Aplicativo
|
data.notificationSettings.inApp | boolean |
Se você deve enviar notificações de aplicativo |
Quando uma nova tarefa é adicionada
Dispara quando uma nova tarefa é adicionada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registro
|
subjectFrontEndUrl | string |
A URL para o registro em StaffCircle |
|
ID
|
data.id | integer |
O identificador da tarefa |
|
Title
|
data.title | string |
O título da tarefa |
|
Description
|
data.description | string |
A descrição da tarefa |
|
Priority
|
data.priority | string |
A prioridade da tarefa |
|
ID do Grupo de Tarefas
|
data.groupId | integer |
O identificador do grupo de tarefas |
|
Título do Grupo de Tarefas
|
data.groupTitle | string |
O título do grupo de tarefas |
|
É Adhoc
|
data.isAdhoc | boolean |
Se esta é uma tarefa adhoc |
|
Criado por ID de pessoa
|
data.createdByPerson.PersonId | integer |
O identificador da pessoa que criou a tarefa |
|
Criado pelo nome
|
data.createdByPerson.FirstName | string |
O nome da pessoa que criou a tarefa |
|
Criado pelo nome da família
|
data.createdByPerson.FamilyName | string |
O nome da família da pessoa que criou a tarefa |
|
Criado por email
|
data.createdByPerson.Email | string |
O email da pessoa que criou a tarefa |
|
ID da pessoa
|
data.person.PersonId | integer |
O identificador da pessoa para a qual a tarefa é |
|
Nome da pessoa
|
data.person.FirstName | string |
O nome da pessoa para a qual a tarefa é |
|
Nome da família da pessoa
|
data.person.FamilyName | string |
O nome da família da pessoa para a qual a tarefa é |
|
Email de pessoa
|
data.person.Email | string |
O email da pessoa para a qual a tarefa é |
|
ID do gerente
|
data.manager.PersonId | integer |
O identificador do gerente da tarefa |
|
Nome do gerente
|
data.manager.FirstName | string |
O primeiro nome do gerente da tarefa |
|
Nome da família do gerente
|
data.manager.FamilyName | string |
O nome da família do gerente da tarefa |
|
Email do Gerenciador
|
data.manager.Email | string |
O email do gerente da tarefa |
|
Data de vencimento
|
data.dueDate | date |
Quando a tarefa for concluída |
|
Data da criação
|
data.createdOn | date-time |
Quando a tarefa foi criada |
|
ID do formulário
|
data.form.id | integer |
O identificador do formulário usado para preencher a tarefa |
|
Título do Formulário
|
data.form.title | string |
O título do formulário usado para preencher a tarefa |
|
Notificações por Push
|
data.notificationSettings.push | boolean |
Se as notificações por push para a tarefa serão enviadas |
|
Notificações por SMS
|
data.notificationSettings.sms | boolean |
Se as notificações por sms para a tarefa serão enviadas |
|
Notificações por email
|
data.notificationSettings.email | boolean |
Se as notificações por email para a tarefa serão enviadas |
|
Notificações do Microsoft Teams
|
data.notificationSettings.microsoftTeams | boolean |
Se as notificações do Microsoft Teams para a tarefa serão enviadas |
|
Em Notificações de Aplicativo
|
data.notificationSettings.inApp | boolean |
Se as notificações no aplicativo para a tarefa serão enviadas |
|
Permitir Curtidas
|
data.contentSettings.allowLikes | boolean |
Se a tarefa permite curtidas |
|
Permitir Comentários
|
data.contentSettings.allowComments | boolean |
Se a tarefa permite comentários |
|
Permitir imagens em comentários
|
data.contentSettings.allowImagesInComments | boolean |
Se a tarefa permite imagens em comentários |
|
Permitir Documentos
|
data.contentSettings.allowDocuments | boolean |
Se a tarefa permite documentos |