StaffCircle (Pré-visualização)
StaffCircle é uma plataforma de sucesso de funcionários que combina a cultura da empresa com a Gestão de Desempenho, a fim de criar equipes de alto desempenho, mesmo em ambientes de trabalho distribuídos. O StafffCircle inclui Objetivo, Avaliações, Valores e Feedback vinculados à sua estrutura de competências. Impulsione o envolvimento e o desempenho com insights profundos.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte StaffCircle |
| URL | https://www.staffcircle.com/contact-us/ |
| support@staffcircle.com |
| Metadados do conector | |
|---|---|
| Editora | StaffCircle |
| Sítio Web | 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 gerir a sua força de trabalho remota, melhorando a gestão do desempenho, as comunicações e a cultura. Você pode se conectar ao StaffCircle para gerenciar suas avaliações one2one, objetivos de desempenho, okrs, feedback 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 este conector, você precisará ter acesso a uma conta StaffCircle. O StaffCircle é um plano de subscrição pago. Se você não tem acesso a uma conta StaffCircle, você pode encontrar mais detalhes aqui.
Como obter credenciais
Se tiver acesso a uma conta StaffCircle, já tem as credenciais necessárias para começar a utilizar este conector. Ao criar uma ligação para o conector StaffCircle, ser-lhe-á pedido que introduza o seu nome de utilizador e palavra-passe. Qualquer credencial de conta StaffCircle pode ser usada aqui. É importante notar que o conector será executado no contexto das credenciais fornecidas, isso inclui levar em conta as permissões de segurança. Isso significa que você deve certificar-se de que a conta StaffCircle que você usa tem as permissões corretas para executar a ação que você está acionando no conector.
Introdução ao conector
Começar a usar o conector StaffCircle é fácil, você só precisa de uma conta StaffCircle. Suas credenciais de usuário podem ser usadas para criar uma conexão com o conector StaffCircle. Uma vez feito, você pode usar um dos nossos gatilhos definidos no conector para começar a acionar fluxos de trabalho automatizados a partir de eventos que ocorrem dentro de sua instância do StaffCircle.
Aqui estão alguns exemplos de fluxos de trabalho:
- Acione um fluxo de trabalho quando um artigo for publicado no StaffCircle e envie uma notificação sobre o artigo para um aplicativo de bate-papo, como o Slack.
- Acione um fluxo de trabalho quando um novo membro da equipe for adicionado ao StaffCircle e conduza um processo de integração que pode incluir comunicações, como e-mails para o novo membro da equipe.
O StaffCircle tem muitos webhooks que não estão todos expostos no conector como gatilhos. Se você não consegue encontrar um gatilho para atender às suas necessidades, considere visualizar nossos webhooks. Nossos webhooks podem ser encontrados dentro do aplicativo web StaffCircle na seção de integração de configurações. Você pode usar o gatilho de fluxo "Quando uma solicitação HTTP é recebida" para gerar uma URL que pode ser dada 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, crie um evento do Calendário do Outlook.
A StaffCircle disponibilizou uma coleção de ações para ajudar a melhorar a comunicação e a gestão objetiva dentro de uma empresa. Ações como "Criar um novo alerta" podem ser usadas para disparar o envio de mensagens em vários canais suportados pelo StaffCircle, como e-mail, sms, MS Teams, In App e Push Notifications. Isso ajuda a manter suas equipes informadas sobre eventos importantes que ocorrem em outros aplicativos.
As ações Objetivo podem ser usadas para automatizar o acompanhamento de KPIs. À medida que os eventos ocorrem em outros aplicativos, por exemplo, ganhar uma oportunidade, você pode atualizar seus objetivos que são definidos no StaffCircle com o valor do negócio.
O StaffCircle forneceu ações de conveniência como "Obter pessoa por e-mail" para ajudar a facilitar a vinculação de 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 de negócios, entre em contato conosco em support@staffcircle.com
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar uma pontuação objetiva |
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 através 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 e-mail |
Tentativas de encontrar um registro de pessoa por e-mail |
| Procura de objetivos |
Procura de objetivos |
Atualizar uma pontuação objetiva
Atualiza um objetivo com uma nova pontuação e uma descrição
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do objetivo
|
objectiveId | True | string |
O objetivo de que a pontuação de progresso deve ser atualizada para |
|
Valor
|
value | True | double |
Progressos totais atuais |
|
É incremento
|
isIncrement | boolean |
Se false, então o valor passado é o valor atual do objetivo. Se verdadeiro, então o valor deve ser adicionado ao total existente |
|
|
Description
|
description | True | string |
Breve descrição dos progressos realizados |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador do registo 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
title | True | string |
O título do alerta |
|
Priority
|
priority | True | string |
Qual é a prioridade do alerta |
|
Resumo
|
summary | string |
Conteúdo essencial da indicação |
|
|
Enviar para todos
|
everyone | boolean |
Caso este alerta seja enviado a todos os utilizadores da empresa |
|
|
Enviar para tags de departamento
|
departmentTags | string |
Uma lista separada por vírgulas das tags de departamento que devem receber o alerta. Não use se Enviar para todos estiver definido como true |
|
|
Enviar para tags de pessoas
|
peopleTags | string |
Uma lista separada por vírgulas das tags de pessoas que devem receber o alerta. Não use se Enviar para todos estiver definido como true |
|
|
Enviar para tags de grupo
|
groupTags | string |
Uma lista separada por vírgulas de tags de grupo que devem receber o alerta. Não use se Enviar para todos estiver definido como true |
|
|
Enviar para tags de site
|
siteTags | string |
Uma lista separada por vírgulas de tags de site que devem receber o alerta. Não use se Enviar para todos estiver definido como true |
|
|
Enviar notificações push
|
push | boolean |
Se os usuários devem ser notificados 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 e-mail
|
boolean |
Se deseja enviar a notificação de alerta por e-mail |
||
|
Enviar notificação de aplicativo
|
inApp | boolean |
Se os usuários devem ser notificados por meio de notificações do aplicativo |
|
|
Enviar notificação do Microsoft Teams
|
teams | boolean |
Se os usuários devem ser notificados por meio de notificações do Microsoft Teams |
Devoluções
| Name | 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 através de vários canais de comunicação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
title | True | string |
O título do artigo. Comprimento máximo 250 caracteres |
|
Priority
|
priority | True | string |
Qual é a prioridade do artigo |
|
Tipo de artigo
|
articleType | True | string |
O tipo de artigo a ser criado |
|
Conteúdo HTML
|
htmlContent | True | string |
O conteúdo HTML principal para o artigo. |
|
URL da imagem do artigo
|
mainImageUrl | string |
O URL para uma imagem que será usada como a imagem principal dos artigos no feed. |
|
|
Resumo
|
summary | string |
Resumo do artigo. O padrão é de 500 caracteres iniciais de conteúdo Html se não for fornecido. |
|
|
Tag
|
tag | True | string |
A tag associada ao artigo. Max caracteres 250 |
|
ID do canal
|
channelId | integer |
Em que canal o artigo será publicado. Se deixado em branco, então será definido para o feed padrão |
|
|
Enviar notificações push
|
push | boolean |
Se os usuários devem ser notificados sobre o artigo por meio de notificações por push |
|
|
Enviar notificações por SMS
|
sms | boolean |
Se os usuários devem ser notificados sobre o artigo por notificações por SMS |
|
|
Enviar notificações por e-mail
|
boolean |
Se os usuários devem ser notificados sobre o artigo por notificações por e-mail |
||
|
Enviar notificações do aplicativo
|
inApp | boolean |
Se os usuários devem ser notificados sobre o artigo por meio de notificações no aplicativo |
|
|
Enviar notificações do Teams
|
teams | boolean |
Se os usuários devem ser notificados sobre o artigo pelas notificações do Microsoft Teams |
|
|
Permitir Gostos
|
allowLikes | boolean |
Os usuários podem gostar do artigo. Padrão true |
|
|
Permitir comentários
|
allowComments | boolean |
Os usuários podem comentar o artigo. Padrão true. |
|
|
Permitir imagens em comentários
|
allowImagesInComments | boolean |
Se as imagens são permitidas nos comentários |
|
|
Pin a partir da data
|
pinFromDate | date-time |
Deve o artigo ser fixado. Em caso afirmativo, indique uma data. Obrigatório se as horas de duração do pino forem fornecidas |
|
|
Horas de Duração do Pino
|
pinDurationHours | integer |
Quantas horas após o Pin From Date o artigo deve permanecer fixado. Obrigatório se o Pin From Date for fornecido. |
|
|
Data Agendada de Publicação Hora
|
scheduledDateTime | string |
Caso este artigo seja agendado para publicação no futuro. |
|
|
Publicar imediatamente
|
publishImmediately | boolean |
Este artigo deve ser publicado imediatamente |
|
|
Publicar ID de usuário
|
publishAsUserId | integer |
Se não for o usuário que está fazendo a chamada de API, qual usuário deve ser feito em nome de. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador do artigo que foi criado |
Criar um novo objetivo
Cria um novo objetivo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Competência
|
categoryId | True | integer |
A competência objetiva associada |
|
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 |
A partir do momento em que o objetivo está a ser medido |
|
Data de fim
|
endDate | True | date-time |
O prazo para o objetivo |
|
Tipo de valor
|
valueType | True | string |
Define como o objetivo é medido |
|
Tag
|
tag | string |
Uma tag de texto, para uso em pesquisas e relatórios. |
|
|
E-mail do gerente
|
managerEmail | string |
O e-mail do gestor responsável pelo acompanhamento do objetivo. O padrão é automaticamente para o gerente de Pessoas ou Departamentos. Obrigatório se a Pessoa ou Departamento não tiver gestor ou se o objetivo for um objetivo da empresa. Usado se o ID do gerente não for fornecido |
|
|
ID do Gestor
|
managerId | integer |
O gestor responsável pelo acompanhamento do objetivo. O padrão é automaticamente para o gerente de Pessoas ou Departamentos. Obrigatório se a Pessoa ou Departamento não tiver gestor ou se o objetivo for um objetivo da empresa. Usado se o e-mail do gerente não for fornecido |
|
|
E-mail da pessoa
|
personEmail | string |
O endereço de e-mail da pessoa a quem se destina o objetivo. Necessário para criar um objetivo pessoal. Se nenhum Departamento ou Pessoa for fornecido, então o objetivo é assumido como um objetivo da empresa |
|
|
ID da pessoa
|
personId | integer |
O ID da pessoa a quem se destina o objetivo. Necessário para criar um objetivo pessoal. Se nenhum Departamento ou Pessoa for fornecido, então o objetivo é assumido como um objetivo da empresa |
|
|
Nome do departamento
|
departmentName | string |
O nome do departamento a quem se destina o objetivo. Necessário para criar um objetivo departamental. Se nenhum Departamento ou Pessoa for fornecido, então o objetivo é assumido como um objetivo da empresa |
|
|
ID do departamento
|
departmentId | integer |
O ID do departamento a quem se destina o objetivo. Necessário para criar um objetivo departamental. Se nenhum Departamento ou Pessoa for fornecido, então o objetivo é assumido como um objetivo da empresa |
|
|
ID do Objetivo da Empresa
|
companyObjectiveId | integer |
Uma ligação opcional a um objetivo da empresa com o 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 se relaciona |
|
|
Valor inicial
|
startValue | double |
Define como o objetivo é medido |
|
|
Target
|
target | double |
O valor-alvo a atingir para que o objetivo seja concluído com êxito |
|
|
Permitir Adicionar Progresso
|
allowAddProgress | boolean |
Se true permite que uma pessoa adicione progresso por conta própria, caso contrário, apenas o gerente especificado pode atualizar o objetivo. Predefinição: false. |
|
|
Tipo recorrente
|
recurType | string |
Se fornecido, então o objetivo é recorrente. Define unidade de tempo para recorrência. |
|
|
Intervalo de recorrência
|
recurInterval | integer |
Quantos dias/semanas/meses/anos o objetivo se repetirá. Obrigatório se o objetivo for recorrente. |
|
|
Progressos acumulados
|
cumulativeProgress | boolean |
Especifica se, ao adicionar progresso do front-end StaffCircle, o progresso é adicionado como um valor incremental. |
|
|
Enviar notificação por push
|
push | boolean |
Envia notificações push. |
|
|
Enviar notificação por SMS
|
sms | boolean |
Enviar notificações por SMS |
|
|
Enviar notificação por e-mail
|
boolean |
Envia atualizações por e-mail |
||
|
Enviar notificação às equipas
|
teams | boolean |
Envia atualizações através das equipas da Microsoft se a integração das equipas estiver ativada |
|
|
Enviar notificação de aplicativo
|
inApp | boolean |
Envia notificações InApp |
|
|
Permite gostos
|
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 anexar aos comentários. |
|
|
Permitir documentos
|
allowDocuments | boolean |
Permitir que documentos sejam anexados a comentários |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do objetivo
|
id | integer |
O identificador objetivo |
Criar um novo objetivo por modelo
Cria um novo objetivo usando um modelo de objetivo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Modelo de Objetivo
|
objectiveTemplateId | True | integer |
Cria um novo objetivo a partir de um modelo de objetivo |
|
Data de início
|
startDate | True | date-time |
A partir do momento em que o objetivo está a ser medido |
|
Data de fim
|
endDate | True | date-time |
O prazo para o objetivo |
|
E-mail da pessoa
|
personEmail | string |
O endereço de e-mail da pessoa a quem se destina o objetivo. Necessário para criar um objetivo pessoal. Se nenhum Departamento ou Pessoa for fornecido, então o objetivo é assumido como um objetivo da empresa |
|
|
ID da pessoa
|
personId | integer |
O ID da pessoa a quem se destina o objetivo. Necessário para criar um objetivo pessoal. Se nenhum Departamento ou Pessoa for fornecido, então o objetivo é assumido como um objetivo da empresa |
|
|
Nome do departamento
|
departmentName | string |
O nome do departamento a quem se destina o objetivo. Necessário para criar um objetivo departamental. Se nenhum Departamento ou Pessoa for fornecido, então o objetivo é assumido como um objetivo da empresa |
|
|
ID do departamento
|
departmentId | integer |
O ID do departamento a quem se destina o objetivo. Necessário para criar um objetivo departamental. Se nenhum Departamento ou Pessoa for fornecido, então o objetivo é assumido como um objetivo da empresa |
|
|
E-mail do gerente
|
managerEmail | string |
O e-mail do gestor responsável pelo acompanhamento do objetivo. O padrão é automaticamente para o gerente de Pessoas ou Departamentos. Obrigatório se a Pessoa ou Departamento não tiver gestor ou se o objetivo for um objetivo da empresa. Usado se o ID do gerente não for fornecido |
|
|
Title
|
title | string |
Substitui o nome do novo objetivo. |
|
|
Description
|
description | string |
Substitui a descrição do novo objetivo. |
|
|
ID do Gestor
|
managerId | integer |
O gestor responsável pelo acompanhamento do objetivo. O padrão é automaticamente para o gerente de Pessoas ou Departamentos. Obrigatório se a Pessoa ou Departamento não tiver gestor ou se o objetivo for um objetivo da empresa. Usado se o e-mail do gerente não for fornecido |
|
|
ID do Objetivo da Empresa
|
companyObjectiveId | integer |
Uma ligação opcional a um objetivo da empresa com o 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 se relaciona |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do objetivo
|
id | integer |
O identificador do objetivo criado |
Criar uma nova Pessoa
Cria uma pessoa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome Próprio
|
firstName | True | string |
O primeiro nome da pessoa |
|
Segundo Nome
|
secondName | True | string |
O segundo nome da pessoa |
|
Email
|
True | string |
Endereço de e-mail profissional da pessoa |
|
|
Telemóvel
|
mobile | True | string |
O número de telemóvel da pessoa |
|
Data de Nascimento
|
dateOfBirth | True | date |
Data de nascimento da pessoa |
|
Data de início
|
startDate | True | string |
Quando a pessoa começou a trabalhar |
|
Linha de Endereço 1
|
addressLine1 | string |
A primeira linha do endereço residencial da pessoa |
|
|
Endereço Linha 2
|
addressLine2 | string |
A segunda linha do endereço residencial da pessoa |
|
|
Localidade
|
town | string |
Cidade de residência da pessoa |
|
|
Código postal
|
postCode | string |
Código postal da pessoa |
|
|
Nome do Concelho
|
countyName | string |
O município de residência da pessoa |
|
|
Nome do país
|
countryName | string |
País de residência da pessoa |
|
|
Nome do título
|
titleName | string |
O título da pessoa |
|
|
Segundo Nome
|
middleName | string |
O nome do meio da pessoa |
|
|
E-mail pessoal
|
homeEmail | string |
O endereço de e-mail pessoal da pessoa |
|
|
Telefone residencial
|
homeTelephone | string |
O número de telefone residencial da pessoa |
|
|
Tag
|
tag | string |
A tag que pode ser usada para fazer referência à pessoa em toda a plataforma StaffCircle |
|
|
E-mail do gerente
|
managerEmail | string |
Endereço de e-mail 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 do Direito de Acesso
|
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 conhecido como |
|
|
URL da imagem do perfil
|
avatarURL | string |
A foto de perfil da pessoa |
|
|
ID do título
|
titleId | integer |
O título da pessoa |
|
|
Identificação do condado
|
countyId | integer |
O município de residência da pessoa |
|
|
ID do país
|
countryId | integer |
País de residência da pessoa |
|
|
Identificação de género
|
genderId | integer |
Identificador de género da pessoa |
|
|
Documento de identificação da nacionalidade
|
nationalityId | integer |
Nacionalidade da pessoa |
|
|
ID da etnia
|
ethnicityId | integer |
A etnia da pessoa |
|
|
Documento de identificação do estado civil
|
maritalStatusId | integer |
Estado civil da pessoa |
|
|
ID do Gestor
|
managerId | integer |
O identificador do gestor da pessoa (apenas o ID do gestor ou o e-mail do gestor podem ser introduzidos) |
|
|
ID do departamento
|
departmentId | integer |
O identificador do departamento da pessoa (apenas o ID do Departamento ou o Nome do Departamento podem ser inseridos) |
|
|
ID da função
|
roleId | integer |
O identificador de função de emprego da pessoa (Somente ID de Função ou Nome da Função pode ser inserido) |
|
|
ID do Site
|
mainSiteId | integer |
O identificador de site ao qual a pessoa pertence |
|
|
Consentimento de contato de emergência
|
emergencyContactConsent | boolean |
Se o contacto de emergência deu consentimento para guardar os seus dados |
|
|
Nome do contato de emergência
|
emergencyContactName | string |
O nome do contacto de emergência da pessoa |
|
|
ID de Relacionamento de Contato de Emergência
|
emergencyRelationshipId | integer |
A relação entre o contacto de emergência e a pessoa |
|
|
Telefone de Contacto de Emergência
|
emergencyContactTelephone | string |
O número de telefone do contacto de emergência da pessoa |
|
|
Endereço de Emergência
|
emergencyAddress | string |
O endereço de emergência das pessoas |
|
|
Próximo do nome de parentesco
|
nextOfKinName | string |
O nome dos parentes mais próximos da pessoa |
|
|
ID de relacionamento próximo de parentes
|
nextOfKinRelationshipId | integer |
A relação entre os parentes mais próximos e a pessoa |
|
|
Telefone Próximo De Kin
|
nextOfKinTelephone | string |
Número de telefone dos parentes mais próximos da pessoa |
|
|
Código de discagem
|
dialingCode | string |
Código de discagem internacional para o número de telefone da pessoa |
|
|
Extensão de Obra
|
workExtension | string |
O número do ramal de trabalho da pessoa |
|
|
Telefone de trabalho
|
telephone | string |
Número de telefone profissional da pessoa |
|
|
Telemóvel Pessoal
|
personalMobile | string |
O número de telemóvel 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 das pessoas termina |
|
|
Situação Laboral
|
employmentStatusId | integer |
Situação profissional da pessoa |
|
|
Situação Laboral Secundária
|
secondaryEmploymentStatusId | integer |
O estatuto de emprego secundário associado |
|
|
Notas de emprego
|
employmentNotes | string |
Notas de emprego relativas à pessoa |
|
|
Notas Médicas
|
medicalNotes | string |
Quaisquer anotações médicas importantes associadas à pessoa |
|
|
Os Dados Pessoais Estão Ativados
|
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 |
Devoluções
| Name | 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
| Name | Chave | Necessá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 derivado do Grupo de Tarefas |
|
|
Description
|
description | string |
Descrição dada à tarefa |
|
|
Planilha
|
formId | True | integer |
A planilha usada na tarefa |
|
Data Para Conclusão
|
dueDate | date-time |
Data de conclusão da tarefa |
|
|
Atribuído ao ID
|
assignedToId | integer |
A quem é atribuída a tarefa. Não pode ser usado se passar Atribuído ao e-mail |
|
|
ID do Gestor
|
managerId | integer |
Quem está gerenciando a tarefa. Não pode ser usado se passar o e-mail do gerente |
|
|
ID do Grupo de Tarefas
|
taskGroupId | True | integer |
O grupo de tarefas ao qual a tarefa está atribuída |
|
Atribuído ao e-mail
|
assignedToEmail | string |
E-mail de quem a tarefa é atribuída. Não pode ser usado se passar Atribuído a Id |
|
|
E-mail do gerente
|
managerEmail | string |
E-mail de quem está gerenciando a tarefa. Não pode ser atribuído se a ID do Gerente for passada |
|
|
ID do Intervalo de Tarefas
|
taskIntervalId | integer |
Id do intervalo de tarefas. Obrigatório se a tarefa for recorrente |
|
|
Enviar notificações 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 e-mail
|
boolean |
Envia notificações por e-mail 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 Gostos
|
allowLikes | boolean |
Permitir que os usuários gostem de comentários sobre a tarefa |
|
|
Permitir comentários
|
allowComments | boolean |
Permitir comentários sobre a tarefa |
|
|
Permitir imagens em comentários
|
allowImagesInComments | boolean |
Todas as imagens a anexar aos comentários |
|
|
Permitir documentos
|
allowDocuments | boolean |
Permitir que documentos sejam anexados a comentários |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador da tarefa |
Obter Pessoa por e-mail
Tentativas de encontrar um registro de pessoa por e-mail
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar e-mail
|
SearchEmail | True | string |
Procurar por e-mail |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
ID
|
results.id | integer |
O ID da pessoa |
|
Nome Próprio
|
results.firstName | string |
O primeiro nome da pessoa |
|
Surname
|
results.secondName | string |
Apelido da pessoa |
|
Conhecido como
|
results.knownAs | string |
Que nome a pessoa gosta de ser conhecida |
|
Email
|
results.email | string |
O endereço de e-mail da Pessoa |
|
Código de discagem
|
results.dialingCode | string |
O código de discagem para o número de telefone da pessoa |
|
Número de telemóvel
|
results.mobile | string |
O número de telemóvel da pessoa |
|
ID do Site Principal
|
results.mainSite.id | integer |
O id do site principal ao qual a pessoa está associada |
|
Nome do Site Principal
|
results.mainSite.name | string |
O nome dado ao site principal |
|
descrição
|
results.mainSite.description | string |
descrição |
|
gestor
|
results.mainSite.manager | string |
gestor |
|
ID do Gestor
|
results.manager.id | integer |
O id das manjedouras |
|
Primeiro Nome dos Gerentes
|
results.manager.firstName | string |
O primeiro nome dos gerentes |
|
Gerentes Segundo Nome
|
results.manager.secondName | string |
O segundo nome dos gerentes |
|
Active
|
results.active | boolean |
se a pessoa está atualmente ativa ou não |
|
ID do departamento
|
results.department.id | integer |
O id do departamento associado à pessoa |
|
Nome do departamento
|
results.department.name | string |
O nome dado ao departamento |
|
Tag
|
results.tag | string |
A tag que representa a pessoa |
|
ID da função
|
results.role.id | integer |
O ID da função |
|
Nome do Direito de Acesso
|
results.role.name | string |
Nome do Direito de Acesso |
|
Imagem de perfil
|
results.avatarURL | string |
O URL para a foto de perfil da pessoa |
|
Status ID
|
results.status.id | integer |
O ID de status do registro |
|
Nome do estado
|
results.status.name | string |
O nome do status do registro |
|
ID do status da pessoa
|
results.personStatus.id | integer |
O ID do 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 |
Procura de objetivos
Procura de objetivos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar Título
|
SearchTitle | string |
Correspondência de cadeia solta para pesquisa com base no título |
|
|
E-mail da pessoa
|
PersonEmail | string |
O e-mail da pessoa à qual o objetivo está atribuído |
|
|
Tag
|
Tag | string |
A tag alocada ao objetivo |
|
|
Closed
|
Closed | string |
Se o objetivo estiver 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 na
|
ActiveAt | date-time |
O objetivo está ativo neste momento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
ID do objetivo
|
results.id | integer |
O identificador objetivo |
|
Title
|
results.title | string |
O título dado ao objetivo |
|
Description
|
results.description | string |
A descrição dada ao objetivo |
|
Tag
|
results.tag | string |
A tag associada ao objetivo |
|
Tipo de Objetivo
|
results.objectiveType | string |
O tipo de objetivo |
|
Closed
|
results.closed | boolean |
Se o Objetivo está fechado |
|
Motivo Fechado
|
results.closedReason | string |
A razão pela qual o objetivo foi fechado |
|
ID da pessoa
|
results.person.id | integer |
O identificador da pessoa para a qual o objetivo se destina |
|
Nome da Pessoa
|
results.person.firstName | string |
O primeiro nome da pessoa para a qual o objetivo é |
|
Nome da Família da Pessoa
|
results.person.secondName | string |
O nome de família da pessoa do objetivo é para |
|
ID do Gestor
|
results.manager.id | integer |
O identificador do gestor |
|
Nome do Gerente
|
results.manager.firstName | string |
O primeiro nome do gerente |
|
Nome da família do gerente
|
results.manager.secondName | string |
O nome de família do gerente |
|
Criado por Person Id
|
results.createdBy.id | integer |
O identificador da pessoa que criou o objetivo |
|
Criado por nome próprio da pessoa
|
results.createdBy.firstName | string |
O primeiro nome da pessoa que criou o objetivo |
|
Criado por nome de família de pessoa
|
results.createdBy.secondName | string |
O nome de família da pessoa que criou o objetivo |
|
ID do departamento
|
results.department.id | integer |
O identificador do departamento ligado ao objetivo |
|
Nome do departamento
|
results.department.name | string |
O nome do departamento ligado ao objetivo |
|
ID do Objetivo do Departamento
|
results.departmentObjective.id | integer |
o identificador do objetivo do departamento |
|
Título Objetivo do Departamento
|
results.departmentObjective.title | string |
O título objetivo do departamento |
|
Descrição do Objetivo do Departamento
|
results.departmentObjective.description | string |
O departamento Descrição Objetiva |
|
ID do Objetivo da Empresa
|
results.companyObjective.id | integer |
O identificador de objetivo da empresa |
|
Título do Objetivo da Empresa
|
results.companyObjective.title | string |
O título objetivo da empresa |
|
Descrição do Objetivo da Empresa
|
results.companyObjective.description | string |
Descrição do objetivo da empresa |
|
Progressos atuais
|
results.currentProgress | double |
Progressos atuais na consecução do objetivo |
|
Data de início
|
results.startDate | string |
A partir do momento em que o objetivo está a ser medido |
|
Data de fim
|
results.endDate | string |
O prazo para o objetivo |
Acionadores
| quando um novo artigo é publicado |
Acionar quando um novo artigo é publicado |
| Quando um novo objetivo é adicionado |
Aciona quando um novo objetivo é adicionado |
| Quando um objetivo é atualizado |
Aciona quando um objetivo é atualizado |
| Quando uma nova ausência é adicionada |
Aciona quando uma nova ausência é adicionada |
| Quando uma nova avaliação é adicionada |
Aciona quando uma nova avaliação é adicionada |
| Quando uma nova pessoa é adicionada |
Aciona quando uma nova pessoa é adicionada |
| Quando uma nova tarefa é adicionada |
Aciona quando uma nova tarefa é adicionada |
quando um novo artigo é publicado
Acionar quando um novo artigo é publicado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | string |
nome |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL do artigo
|
subjectFrontEndUrl | string |
O 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 |
|
Tag
|
data.Tag | string |
A tag associada ao artigo |
|
Nome da prioridade
|
data.PriorityName | string |
A prioridade do artigo |
|
Criado em
|
data.CreatedAt | date-time |
A data em que o artigo foi criado pela primeira vez |
|
Everyone
|
data.AudienceDto.Everyone | boolean |
Se o artigo está sendo publicado para todos |
|
Pessoas
|
data.AudienceDto.Persons | array of object | |
|
Etiqueta de Pessoa
|
data.AudienceDto.Persons.Tag | string |
Etiqueta de Pessoa Alvo |
|
Id
|
data.AudienceDto.Persons.Id | integer |
Tag Id |
|
Sites
|
data.AudienceDto.Sites | array of object | |
|
Site Tag
|
data.AudienceDto.Sites.Tag | string |
Tag do site de destino |
|
Id
|
data.AudienceDto.Sites.Id | integer |
Tag Id |
|
Departmentos
|
data.AudienceDto.Departments | array of object | |
|
Tag do Departamento
|
data.AudienceDto.Departments.Tag | string |
Tag do departamento de destino |
|
Id
|
data.AudienceDto.Departments.Id | integer |
Tag Id |
|
Criado por ID
|
data.CreatedByPerson.PersonId | integer |
O identificador da pessoa que criou o artigo |
|
Criado pelo primeiro nome
|
data.CreatedByPerson.FirstName | string |
O primeiro nome da pessoa que criou o artigo |
|
Criado por nome de família
|
data.CreatedByPerson.FamilyName | string |
O nome de família da pessoa que criou o artigo |
|
Criado por e-mail
|
data.CreatedByPerson.Email | string |
O endereço de e-mail da pessoa que criou o artigo |
|
Modificados Em
|
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 primeiro nome
|
data.ModifiedByPerson.FirstName | string |
O primeiro nome da pessoa que modificou o artigo pela última vez |
|
Modificado por nome de família
|
data.ModifiedByPerson.FamilyName | string |
O apelido da pessoa que modificou o artigo pela última vez |
|
Modificado por e-mail
|
data.ModifiedByPerson.Email | string |
O endereço de e-mail 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 em texto simples |
|
ID da imagem principal
|
data.MainImageId | integer |
O ID de uma imagem que será usada como imagem principal dos artigos no feed. |
Quando um novo objetivo é adicionado
Aciona quando um novo objetivo é adicionado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registo
|
subjectFrontEndUrl | string |
O URL para o registro no StaffCircle |
|
ID do objetivo
|
data.id | integer |
O identificador do objetivo |
|
Modelo de Objetivo
|
data.templateId | integer |
Cria um novo objetivo a partir de um modelo de objetivo |
|
ID do Gestor
|
data.manager.PersonId | integer |
Identificador do gestor da pessoa |
|
Nome do Gerente
|
data.manager.FirstName | string |
O primeiro nome do gerente da pessoa |
|
Nome da família do gerente
|
data.manager.FamilyName | string |
Nome de família do gerente da pessoa |
|
E-mail do gerente
|
data.manager.Email | string |
O endereço de e-mail do gerente da pessoa |
|
Identificador de Pessoa
|
data.person.PersonId | integer |
O identificador da pessoa ligado ao objetivo |
|
Nome da Pessoa
|
data.person.FirstName | string |
O primeiro nome da pessoa ligado ao objetivo |
|
Nome da Família da Pessoa
|
data.person.FamilyName | string |
O apelido da pessoa ligado ao objetivo |
|
E-mail da pessoa
|
data.person.Email | string |
O endereço de e-mail da pessoa vinculado ao objetivo |
|
Title
|
data.title | string |
O nome do novo objetivo |
|
Description
|
data.description | string |
Descrição do novo objetivo |
|
Tipo de valor
|
data.valueType | string |
Define como o objetivo é medido |
|
Tag
|
data.tag | string |
Uma tag de texto, para uso em pesquisas e relatórios |
|
Categoria
|
data.category | string |
O identificador da categoria de objetivos |
|
Data de início
|
data.startDate | date-time |
A partir do momento em que o objetivo está a ser medido |
|
Data de fim
|
data.endDate | string |
O prazo para o objetivo |
|
Data do Último Progresso
|
data.lastProgressDate | date-time |
Data em que se registaram progressos na consecução do objetivo |
|
fechado
|
data.closed | boolean |
fechado |
|
Permitir Adicionar Progresso
|
data.allowAddProgress | boolean |
Se true permite que uma pessoa adicione progresso por conta própria, caso contrário, apenas o gerente especificado pode atualizar o objetivo |
|
Notificação push
|
data.notificationSettings.push | boolean |
Envia notificações push. |
|
Notificação por SMS
|
data.notificationSettings.sms | boolean |
Enviar notificações por SMS |
|
Notificação por e-mail
|
data.notificationSettings.email | boolean |
Envia atualizações por e-mail |
|
Notificação de equipas
|
data.notificationSettings.microsoftTeams | boolean |
Envia atualizações através das equipas da Microsoft se a integração das equipas estiver ativada |
|
Na notificação do aplicativo
|
data.notificationSettings.inApp | boolean |
Envia notificações InApp |
|
Permite gostos
|
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 anexar 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 tiver sido criado |
|
Criado por Person Id
|
data.createdByPerson.PersonId | integer |
O identificador da pessoa que criou o objetivo |
|
Criado por nome próprio da pessoa
|
data.createdByPerson.FirstName | string |
O primeiro nome da pessoa que criou o objetivo |
|
Criado por nome de família de pessoa
|
data.createdByPerson.FamilyName | string |
O nome de família da pessoa que criou o objetivo |
|
Criado por e-mail pessoal
|
data.createdByPerson.Email | string |
O endereço de e-mail da pessoa que criou o objetivo |
|
Progressos atuais
|
data.currentProgress | double |
Progressos atuais na consecução do objetivo |
|
Valor inicial
|
data.startValue | double |
Define como o objetivo é medido |
|
Target
|
data.targetValue | double |
O valor-alvo a atingir para que o objetivo seja concluído com êxito |
Quando um objetivo é atualizado
Aciona quando um objetivo é atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registo
|
subjectFrontEndUrl | string |
O URL para o registro no StaffCircle |
|
ID
|
data.id | integer |
O identificador do registo de progresso objetivo |
|
ID do objetivo
|
data.objectiveId | integer |
O objetivo ao qual este registo de progresso está associado |
|
Valor
|
data.value | double |
O valor de progresso total para o objeto |
|
Description
|
data.description | string |
A descrição adicionada ao registo de progresso objetivo |
|
Criado em
|
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 primeiro nome
|
data.createdByPerson.FirstName | string |
O primeiro nome da pessoa que criou o registro de progresso objetivo |
|
Criado por nome de família
|
data.createdByPerson.FamilyName | string |
O nome de família da pessoa que criou o registro de progresso objetivo |
|
Criado por e-mail
|
data.createdByPerson.Email | string |
O endereço de e-mail 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
Aciona quando uma nova ausência é adicionada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registo
|
subjectFrontEndUrl | string |
O URL do registo no StaffCircle |
|
ID
|
data.id | integer |
O identificador da ausência |
|
ID da pessoa
|
data.requestedForPerson.PersonId | integer |
O identificador da pessoa para a qual o pedido de ausência se destina |
|
Nome da Pessoa
|
data.requestedForPerson.FirstName | string |
O primeiro nome da pessoa para a qual se destina o pedido de ausência |
|
Nome da Família da Pessoa
|
data.requestedForPerson.FamilyName | string |
O apelido da pessoa para a qual se destina o pedido de ausência |
|
E-mail da pessoa
|
data.requestedForPerson.Email | string |
O endereço de e-mail da pessoa para a qual o pedido de ausência se destina |
|
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 fora |
|
Dia parcial
|
data.partialDay | string |
Se foi solicitado um dia parcial de folga (manhã, tarde) |
|
Data de início
|
data.start | date-time |
Quando começa a ausência |
|
Data de fim
|
data.end | date-time |
Quando a ausência chega ao fim |
|
ID do tipo
|
data.typeId | integer |
O identificador do tipo de ausência solicitada |
|
Tipo
|
data.type | string |
O tipo de ausência que está a ser solicitada |
|
ID do subtipo
|
data.subTypeId | integer |
O identificador do subtipo de ausência solicitado |
|
ID da Política
|
data.policyId | integer |
O identificador da política de ausências em que o membro da equipe está |
|
Reason
|
data.reason | string |
O motivo do pedido de ausência |
|
Criado em
|
data.createdAt | date-time |
Quando foi feito o pedido de ausência |
|
Criado por ID
|
data.createdByPerson.PersonId | integer |
O identificador da pessoa que criou o pedido de ausência |
|
Criado pelo primeiro nome
|
data.createdByPerson.FirstName | string |
O primeiro nome da pessoa que criou o pedido de ausência |
|
Criado por nome de família
|
data.createdByPerson.FamilyName | string |
O apelido da pessoa que criou o pedido de ausência |
|
Criado por e-mail
|
data.createdByPerson.Email | string |
O endereço de e-mail da pessoa que criou o pedido de ausência |
|
Estado de aprovação
|
data.approvalDetails.status | string |
O status da aprovação (Pendente,Aprovado,Recusado) |
|
Aprovado em
|
data.approvalDetails.approvedAt | date-time |
Quando a ausência foi confirmada |
|
Resposta de aprovação
|
data.approvalDetails.response | string |
A resposta dada pelo aprovador |
|
Aprovado por ID
|
data.approvalDetails.approvedByPerson.PersonId | integer |
O identificador da pessoa que aprovou a ausência |
|
Aprovado pelo primeiro nome
|
data.approvalDetails.approvedByPerson.FirstName | string |
O primeiro nome da pessoa que aprovou a ausência |
|
Aprovado por nome de família
|
data.approvalDetails.approvedByPerson.FamilyName | string |
O apelido da pessoa que aprovou a ausência |
|
Aprovado por e-mail
|
data.approvalDetails.approvedByPerson.Email | string |
O endereço de e-mail da pessoa que aprovou a ausência |
|
ID do Gestor
|
data.manager.PersonId | integer |
O identificador do gestor envolvido no pedido de ausência |
|
Nome do Gerente
|
data.manager.FirstName | string |
O primeiro nome do gestor envolvido no pedido de ausência |
|
Nome da família do gerente
|
data.manager.FamilyName | string |
O apelido do gerente envolvido no pedido de ausência |
|
E-mail do gerente
|
data.manager.Email | string |
O endereço de e-mail do gestor envolvido no pedido de ausência |
Quando uma nova avaliação é adicionada
Aciona quando uma nova avaliação é adicionada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registo
|
subjectFrontEndUrl | string |
O URL do registo no 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 Gestor
|
data.manager.PersonId | integer |
O identificador do gestor associado à revisão |
|
Nome do Gerente
|
data.manager.FirstName | string |
O primeiro nome do gerente associado à avaliação |
|
Nome da família do gerente
|
data.manager.FamilyName | string |
O apelido do gestor associado à avaliação |
|
E-mail do gerente
|
data.manager.Email | string |
O endereço de e-mail do gerente associado à avaliação |
|
internalReviewerPersonIds
|
data.internalReviewerPersonIds | array of integer |
internalReviewerPersonIds |
|
ID do revisor
|
data.person.PersonId | integer |
O identificador do examinador |
|
Nome do revisor
|
data.person.FirstName | string |
O primeiro nome do revisor |
|
Nome de família do revisor
|
data.person.FamilyName | string |
O apelido do revisor |
|
E-mail do revisor
|
data.person.Email | string |
O endereço de e-mail do revisor |
|
Title
|
data.title | string |
O título dado à revisão |
|
Description
|
data.description | string |
A descrição dada à revisão |
|
Tipo de avaliação
|
data.reviewType | string |
O tipo de revisão |
|
Vencimento em
|
data.dueOn | date-time |
Quando a revisão deve ser feita |
|
attachedDocumentIds
|
data.attachedDocumentIds | array of integer |
attachedDocumentIds |
|
linkedObjectivos
|
data.linkedObjectives | array of integer |
linkedObjectivos |
|
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 das avaliações |
|
Criado em
|
data.createdAt | date-time |
Quando a avaliação foi criada |
|
Criado por ID
|
data.createdByPerson.PersonId | integer |
O identificador da pessoa que criou a revisão |
|
Criado pelo primeiro nome
|
data.createdByPerson.FirstName | string |
O primeiro nome da pessoa que criou a avaliação |
|
Criado por nome de família
|
data.createdByPerson.FamilyName | string |
O nome de família da pessoa que criou a avaliação |
|
Criado por e-mail
|
data.createdByPerson.Email | string |
O endereço de e-mail da pessoa que criou a avaliação |
|
Permitir Gostos
|
data.contentSettings.allowLikes | boolean |
Se os gostos 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 nos comentários |
|
Permitir documentos
|
data.contentSettings.allowDocuments | boolean |
Se os documentos podem ser anexados à revisão |
|
Notificações push
|
data.notificationSettings.push | boolean |
Se deseja enviar notificações por push |
|
Notificações por SMS
|
data.notificationSettings.sms | boolean |
Se deseja enviar notificações por sms |
|
Notificação por e-mail
|
data.notificationSettings.email | boolean |
Se deseja enviar notificações por e-mail |
|
Notificações do Microsoft Teams
|
data.notificationSettings.microsoftTeams | boolean |
Se deseja enviar notificações do Microsoft Teams |
|
Em Notificações do aplicativo
|
data.notificationSettings.inApp | boolean |
Se as notificações do aplicativo devem ser enviadas |
Quando uma nova pessoa é adicionada
Aciona quando uma nova pessoa é adicionada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registo
|
subjectFrontEndUrl | string |
O URL para o registro no StaffCircle |
|
ID da pessoa
|
data.id | integer |
O identificador que representa a pessoa |
|
Nome Próprio
|
data.givenName | string |
O primeiro nome da pessoa |
|
Segundo Nome
|
data.middleName | string |
O nome do meio da pessoa |
|
Nome de família
|
data.familyName | string |
Nome de família da pessoa |
|
conhecido como
|
data.knownAs | string |
Que nome a pessoa gosta de ser conhecida |
|
Data de Nascimento
|
data.dateOfBirth | date |
Data de nascimento da pessoa |
|
E-mail pessoal
|
data.contactDetails.personalEmail | string |
O endereço de e-mail pessoal da pessoa |
|
E-mail de trabalho
|
data.contactDetails.workEmail | string |
Endereço de e-mail profissional da pessoa |
|
Trabalhe em dispositivos móveis
|
data.contactDetails.workMobile | string |
O número de telemóvel de trabalho da pessoa |
|
Telemóvel Pessoal
|
data.contactDetails.personalMobile | string |
O número de telemóvel pessoal da pessoa |
|
Telefone Residencial
|
data.contactDetails.homeTelephone | string |
O número de telefone residencial da pessoa |
|
Telefone de trabalho
|
data.contactDetails.workTelephone | string |
Número de telefone profissional da pessoa |
|
Telefone de trabalho
|
data.contactDetails.workExtension | string |
O número do ramal de trabalho da pessoa |
|
Linha de Endereço 1
|
data.address.addressLine1 | string |
A primeira linha do endereço residencial da pessoa |
|
Endereço Linha 2
|
data.address.addressLine2 | string |
A primeira linha do endereço residencial da pessoa |
|
Localidade
|
data.address.town | string |
Cidade de residência da pessoa |
|
Código postal
|
data.address.postCode | string |
Código postal da pessoa |
|
Nome do contato de emergência
|
data.emergencyContact.emergencyContactName | string |
O nome do contacto de emergência da pessoa |
|
Telefone de Contacto de Emergência
|
data.emergencyContact.emergencyContactTelephone | string |
O número de telefone do contacto de emergência da pessoa |
|
ID de Relacionamento de Contato de Emergência
|
data.emergencyContact.emergencyRelationshipId | integer |
A relação entre o contacto de emergência e a pessoa |
|
Consentimento de contato de emergência
|
data.emergencyContact.emergencyContactConsent | boolean |
Se o contacto de emergência deu consentimento para guardar os seus dados |
|
Endereço de contato de emergência
|
data.emergencyContact.emergencyAddress | string |
O endereço de contacto de emergência das pessoas |
|
Notas Médicas
|
data.emergencyContact.emergencyMedicalNotes | string |
Quaisquer anotações médicas importantes associadas à pessoa |
|
Próximo de Nome de Kin
|
data.nextOfKin.Name | string |
O parente mais próximo da pessoa |
|
Telefone próximo de Kin
|
data.nextOfKin.Telephone | string |
Número de telefone dos parentes mais próximos da pessoa |
|
Próximo do ID de relacionamento de parentesco
|
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 relativas à pessoa |
|
Tag
|
data.employeeDetails.tag | string |
A tag que pode ser usada para fazer referência à pessoa em toda a plataforma StaffCircle |
|
Data de início
|
data.employeeDetails.startDate | string |
Quando a pessoa começou a trabalhar |
|
ID do Site
|
data.employeeDetails.siteId | integer |
O identificador de 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 a que a pessoa pertence |
|
ID do Gestor
|
data.employeeDetails.manager.PersonId | integer |
O identificador do gerente do parson |
|
Nome do Gerente
|
data.employeeDetails.manager.FirstName | string |
O primeiro nome do gerente da pessoa |
|
Nome de família do gerente
|
data.employeeDetails.manager.FamilyName | string |
O apelido do gestor da pessoa |
|
E-mail do gerente
|
data.employeeDetails.manager.Email | string |
O endereço de e-mail do gerente da pessoa |
|
Estado da Conta
|
data.accountStatus | integer |
Status da conta StaffCircle da pessoa |
Quando uma nova tarefa é adicionada
Aciona quando uma nova tarefa é adicionada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome dado ao webhook |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL de registo
|
subjectFrontEndUrl | string |
O URL para o registro no 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 trabalho |
|
É adhoc
|
data.isAdhoc | boolean |
Se esta é uma tarefa ad hoc |
|
Criado por ID de Pessoa
|
data.createdByPerson.PersonId | integer |
O identificador da pessoa que criou a tarefa |
|
Criado pelo primeiro nome
|
data.createdByPerson.FirstName | string |
O primeiro nome da pessoa que criou a tarefa |
|
Criado por nome de família
|
data.createdByPerson.FamilyName | string |
O nome de família da pessoa que criou a tarefa |
|
Criado por e-mail
|
data.createdByPerson.Email | string |
O e-mail da pessoa que criou a tarefa |
|
ID da pessoa
|
data.person.PersonId | integer |
O identificador da pessoa para a qual a tarefa se destina |
|
Nome da Pessoa
|
data.person.FirstName | string |
O primeiro nome da pessoa para a qual a tarefa se destina |
|
Nome da Família da Pessoa
|
data.person.FamilyName | string |
O nome de família da pessoa para a qual a tarefa se destina |
|
E-mail da pessoa
|
data.person.Email | string |
O e-mail da pessoa para a qual a tarefa se destina |
|
ID do Gestor
|
data.manager.PersonId | integer |
O identificador do gestor da tarefa |
|
Nome do Gerente
|
data.manager.FirstName | string |
O primeiro nome do gestor da tarefa |
|
Nome da família do gerente
|
data.manager.FamilyName | string |
O apelido do gestor da tarefa |
|
E-mail do gerente
|
data.manager.Email | string |
O e-mail do gestor da tarefa |
|
Data Para Conclusão
|
data.dueDate | date |
Quando a tarefa é devida |
|
Criado em
|
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 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 e-mail
|
data.notificationSettings.email | boolean |
Se as notificações por e-mail para a tarefa serão enviadas |
|
Notificações do Microsoft Teams
|
data.notificationSettings.microsoftTeams | boolean |
Se no Microsoft Teams as notificações para a tarefa serão enviadas |
|
Em Notificações do aplicativo
|
data.notificationSettings.inApp | boolean |
Se as notificações do aplicativo para a tarefa serão enviadas |
|
Permitir Gostos
|
data.contentSettings.allowLikes | boolean |
Se a tarefa permite gostos |
|
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 |