StaffCircle (förhandsversion)
StaffCircle är en framgångsplattform för anställda som kombinerar företagskulturen med Performance Management för att skapa högpresterande team även i distribuerade arbetsmiljöer. StafffCircle innehåller mål, recensioner, värden och feedback som är länkade till ditt kompetensramverk. Skapa engagemang och prestanda med djup insikt.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | StaffCircle Support |
| URL | https://www.staffcircle.com/contact-us/ |
| E-postmeddelande | support@staffcircle.com |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | StaffCircle |
| Webbplats | https://www.staffcircle.com/ |
| Integritetspolicy | https://www.staffcircle.com/privacy-policy/ |
| Kategorier | Kommunikation; Personal |
StaffCircle hjälper organisationer att hantera sin distanspersonal genom att förbättra prestandahantering, comms och kultur. Du kan ansluta till StaffCircle för att hantera dina one2one-recensioner, prestandamål, okrs, feedback i realtid, utmärkelser och erkännande. Du kan utföra olika åtgärder som att skapa eller uppdatera prestandamål, tilldela utmärkelser, skapa artiklar och aviseringar, uppdatera användarinformation och mycket mer.
Förutsättningar
Om du vill använda den här anslutningsappen måste du ha åtkomst till ett StaffCircle-konto. StaffCircle är en betald prenumerationsplan. Om du inte har åtkomst till ett StaffCircle-konto hittar du mer information här.
Hämta autentiseringsuppgifter
Om du har åtkomst till ett StaffCircle-konto har du redan de autentiseringsuppgifter du behöver för att börja använda den här anslutningsappen. När du skapar en anslutning för StaffCircle-anslutningsappen uppmanas du att ange ditt användarnamn och lösenord. Alla autentiseringsuppgifter för StaffCircle-konton kan användas här. Det är viktigt att observera att anslutningsappen körs i kontexten för de angivna autentiseringsuppgifterna, vilket innefattar att ta hänsyn till säkerhetsbehörigheter. Det innebär att du måste se till att Det StaffCircle-konto som du använder har rätt behörighet för att utföra åtgärden som utlöses i anslutningsappen.
Komma igång med anslutningsappen
Det är enkelt att komma igång med StaffCircle-anslutningsappen. Du behöver bara ett StaffCircle-konto. Dina användarautentiseringsuppgifter kan användas för att skapa en anslutning till StaffCircle-anslutningsappen. När du är klar kan du använda en av våra utlösare som definierats i anslutningsappen för att börja utlösa automatiserade arbetsflöden från händelser som inträffar i din StaffCircle-instans.
Här är några exempel på arbetsflöden
- Utlös ett arbetsflöde när en artikel publiceras i StaffCircle och skicka ett meddelande om artikeln till ett chattprogram som Slack.
- Utlös ett arbetsflöde när en ny anställd läggs till i StaffCircle och kör en registreringsprocess som kan inkludera kommunikation som e-postmeddelanden till den nya medarbetaren.
StaffCircle har många webhooks som inte alla exponeras i anslutningsappen som utlösare. Om du inte hittar en utlösare som passar dina behov kan du titta på våra webhooks. Våra webhooks finns i StaffCircle-webbappen under integreringsavsnittet i inställningarna. Du kan använda flödesutlösaren "När en HTTP-begäran tas emot" för att generera en URL som kan ges till webhooken StaffCircle för att utlösa ett arbetsflöde.
Ett exempel på ett sådant arbetsflöde skulle vara
- När en semesterbegäran görs för en anställd skapar du en Outlook Calendar-händelse.
StaffCircle har gjort en samling åtgärder tillgängliga för att förbättra kommunikationen och den objektiva hanteringen inom ett företag. Åtgärder som "Skapa en ny avisering" kan användas för att utlösa utskick av meddelanden över flera kanaler som StaffCircle stöder, till exempel e-post, sms, MS Teams, In App och Push-meddelanden. Detta hjälper till att hålla dina team informerade om viktiga händelser som inträffar i andra program.
Objektiva åtgärder kan användas för att automatisera spårning av KPI:er. När händelser inträffar i andra program, till exempel om du vinner en affärsmöjlighet, kan du uppdatera dina mål som anges i StaffCircle med värdet för affären.
StaffCircle har tillhandahållit bekvämlighetsåtgärder som "Hämta person via e-post" för att göra det enkelt att länka personal till andra åtgärder som "Skapa en ny uppgift"
Support
Om du har problem med att konfigurera StaffCircle-anslutningsappen eller behöver funktioner för att uppfylla dina affärsbehov kontaktar du oss på support@staffcircle.com
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Hämta person via e-post |
Försöker hitta en personpost via e-post |
| Skapa en ny artikel |
Skapar en ny artikel som kan distribueras till StaffCircle-användare via flera kommunikationskanaler |
| Skapa en ny avisering |
Skapar en ny avisering som kan distribueras till StaffCircle-användare via flera kommunikationskanaler |
| Skapa en ny person |
Skapar en person |
| Skapa en ny uppgift |
Skapar en ny uppgift och tilldelar den till en användare |
| Skapa ett nytt mål |
Skapar ett nytt mål |
| Skapa ett nytt mål efter mall |
Skapar ett nytt mål med hjälp av en målmall |
| Sök efter mål |
Sök efter mål |
| Uppdatera en målpoäng |
Uppdaterar ett mål med en ny poäng och en beskrivning |
Hämta person via e-post
Försöker hitta en personpost via e-post
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sök efter e-post
|
SearchEmail | True | string |
Sök via e-post |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
ID-nummer
|
results.id | integer |
Personens ID |
|
Förnamn
|
results.firstName | string |
Personens förnamn |
|
Surname
|
results.secondName | string |
Personens efternamn |
|
Kallas
|
results.knownAs | string |
Vilket namn personen gillar att bli känd som |
|
E-postmeddelande
|
results.email | string |
Personens e-postadress |
|
Uppringningskod
|
results.dialingCode | string |
Uppringningskoden för personens telefonnummer |
|
Mobilnummer
|
results.mobile | string |
Personens mobiltelefonnummer |
|
Huvudwebbplats-ID
|
results.mainSite.id | integer |
ID för huvudwebbplatsen som personen är associerad med |
|
Namn på huvudwebbplats
|
results.mainSite.name | string |
Namnet på huvudwebbplatsen |
|
beskrivning
|
results.mainSite.description | string |
beskrivning |
|
föreståndare
|
results.mainSite.manager | string |
föreståndare |
|
Chefs-ID
|
results.manager.id | integer |
Mangers-ID:t |
|
Förnamn för chefer
|
results.manager.firstName | string |
Chefernas förnamn |
|
Chefers andra namn
|
results.manager.secondName | string |
Chefernas andra namn |
|
Active
|
results.active | boolean |
om personen för närvarande är aktiv eller inte |
|
Avdelnings-ID
|
results.department.id | integer |
ID:t för den avdelning som är kopplad till personen |
|
Avdelningsnamn
|
results.department.name | string |
Det namn som har angetts för avdelningen |
|
Tag
|
results.tag | string |
Taggen som mottagar personen |
|
Roll-ID
|
results.role.id | integer |
Roll-ID:t |
|
Rollnamn
|
results.role.name | string |
Rollnamn |
|
Profilbild
|
results.avatarURL | string |
URL:en till personens profilbild |
|
Status-ID
|
results.status.id | integer |
Postens status-ID |
|
Statusnamn
|
results.status.name | string |
Postens statusnamn |
|
Personstatus-ID
|
results.personStatus.id | integer |
Personens status-ID |
|
Namn på personstatus
|
results.personStatus.name | string |
Personens statusnamn |
|
Startdatum
|
results.startDate | string |
När personen började arbeta på organisationen |
Skapa en ny artikel
Skapar en ny artikel som kan distribueras till StaffCircle-användare via flera kommunikationskanaler
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Titel
|
title | True | string |
Artikelns rubrik. Maxlängd 250 tecken |
|
Priority
|
priority | True | string |
Vad är prioriteten i artikeln |
|
Artikeltyp
|
articleType | True | string |
Den typ av artikel som ska skapas |
|
HTML-innehåll
|
htmlContent | True | string |
Artikelns huvudsakliga HTML-innehåll. |
|
Url för artikelbild
|
mainImageUrl | string |
URL:en till en bild som ska användas som artiklarnas huvudbild i flödet. |
|
|
Sammanfattning
|
summary | string |
En sammanfattning av artikeln. Standardvärdet är de första 500 tecken html-innehållet om det inte tillhandahålls. |
|
|
Tag
|
tag | True | string |
Taggen som är associerad med artikeln. Maxtecken 250 |
|
Kanal-ID
|
channelId | integer |
Vilken kanal kommer artikeln att publiceras till. Om den lämnas tom ställs den in på standardfeeden |
|
|
Skicka push-meddelanden
|
push | boolean |
Om du vill meddela användarna om artikeln via push-meddelanden |
|
|
Skicka SMS-meddelanden
|
sms | boolean |
Om du vill meddela användarna om artikeln via SMS-meddelanden |
|
|
Skicka e-postaviseringar
|
boolean |
Om du vill meddela användarna om artikeln via e-postaviseringar |
||
|
Skicka in appaviseringar
|
inApp | boolean |
Om du vill meddela användare om artikeln med i appaviseringar |
|
|
Skicka Teams-meddelanden
|
teams | boolean |
Om du vill meddela användare om artikeln av Microsoft Teams-meddelanden |
|
|
Tillåt gilla-markeringar
|
allowLikes | boolean |
Kan användare gilla artikeln. Standard sant |
|
|
Tillåt kommentarer
|
allowComments | boolean |
Kan användarna kommentera artikeln. Förval: sant. |
|
|
Tillåt bilder i kommentarer
|
allowImagesInComments | boolean |
Om bilder tillåts i kommentarer |
|
|
Fäst från datum
|
pinFromDate | date-time |
Ska artikeln fästas. Om så är fallet ange ett datum. Krävs om pin-varaktighetstimmar anges |
|
|
Pin-varaktighet timmar
|
pinDurationHours | integer |
Hur många timmar efter pin-koden från datum ska artikeln förbli fäst. Krävs om Pin From Date anges. |
|
|
Schemalagd datumtid för publikation
|
scheduledDateTime | string |
Bör den här artikeln schemaläggas för publicering i framtiden. |
|
|
Publicera omedelbart
|
publishImmediately | boolean |
Bör den här artikeln publiceras direkt |
|
|
Publicera användar-ID
|
publishAsUserId | integer |
Om inte den användare som gör API-anropet, vilken användare som ska göra detta på uppdrag av. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Identifieraren för artikeln som har skapats |
Skapa en ny avisering
Skapar en ny avisering som kan distribueras till StaffCircle-användare via flera kommunikationskanaler
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Titel
|
title | True | string |
Aviseringens rubrik |
|
Priority
|
priority | True | string |
Vilken prioritet är aviseringen |
|
Sammanfattning
|
summary | string |
Huvudinnehållet i aviseringen |
|
|
Skicka till alla
|
everyone | boolean |
Om den här aviseringen skickas till alla användare i företaget |
|
|
Skicka till avdelningstaggar
|
departmentTags | string |
En kommaavgränsad lista över avdelningstaggar som ska ta emot aviseringen. Använd inte om Skicka till alla är inställt på sant |
|
|
Skicka till personer-taggar
|
peopleTags | string |
En kommaavgränsad lista över persontaggar som ska få aviseringen. Använd inte om Skicka till alla är inställt på sant |
|
|
Skicka till grupptaggar
|
groupTags | string |
En kommaavgränsad lista över grupptaggar som ska ta emot aviseringen. Använd inte om Skicka till alla är inställt på sant |
|
|
Skicka till webbplatstaggar
|
siteTags | string |
En kommaavgränsad lista över webbplatstaggar som ska ta emot aviseringen. Använd inte om Skicka till alla är inställt på sant |
|
|
Skicka push-meddelanden
|
push | boolean |
Om användare ska meddelas via push-meddelanden |
|
|
Skicka SMS-meddelanden
|
sms | boolean |
Om användarna ska meddelas via SMS-meddelanden |
|
|
Skicka e-postavisering
|
boolean |
Om aviseringsmeddelandet ska skickas via e-post |
||
|
Skicka i appavisering
|
inApp | boolean |
Om du vill meddela användare via i appaviseringar |
|
|
Skicka Microsoft Teams-meddelande
|
teams | boolean |
Om användare ska meddelas via Microsoft Teams-meddelanden |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Identifieraren för aviseringen |
Skapa en ny person
Skapar en person
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Förnamn
|
firstName | True | string |
Personens förnamn |
|
Andra namn
|
secondName | True | string |
Personens andra namn |
|
E-postmeddelande
|
True | string |
Personens e-postadress till arbetet |
|
|
Mobil
|
mobile | True | string |
Personens mobiltelefonnummer |
|
Födelsedatum
|
dateOfBirth | True | date |
Personens födelsedatum |
|
Startdatum
|
startDate | True | string |
När personens anställning började |
|
Adressrad 1
|
addressLine1 | string |
Personens första rad i sin hemadress |
|
|
Adressrad 2
|
addressLine2 | string |
Personens andra rad i hemadressen |
|
|
Stad
|
town | string |
Personens bostad |
|
|
Postnummer
|
postCode | string |
Personens postnummer |
|
|
Länsnamn
|
countyName | string |
Personens bostadsort |
|
|
Namn på land
|
countryName | string |
Personens bosättningsland |
|
|
Namn på rubrik
|
titleName | string |
Personens titel |
|
|
Mellannamn
|
middleName | string |
Personens mellannamn |
|
|
Personlig e-post
|
homeEmail | string |
Personens personliga e-postadress |
|
|
Hemtelefon
|
homeTelephone | string |
Personens hemtelefonnummer |
|
|
Tag
|
tag | string |
Taggen som kan användas för att referera till personen i hela StaffCircle-plattformen |
|
|
E-post för chef
|
managerEmail | string |
Personens e-postadress till chefen. Detta kan användas för att länka en chef till en person |
|
|
Avdelningsnamn
|
departmentName | string |
Namnet på den avdelning som personen tillhör |
|
|
Rollnamn
|
roleName | string |
Personens roll. Detta kan användas för att länka en roll till en person |
|
|
Kallas
|
knownAs | string |
Namnet som personen föredrar att kallas |
|
|
URL för profilbild
|
avatarURL | string |
Personens profilbild |
|
|
Rubrik-ID
|
titleId | integer |
Personens titel |
|
|
Läns-ID
|
countyId | integer |
Personens bostadsort |
|
|
Lands-ID
|
countryId | integer |
Personens bosättningsland |
|
|
Köns-ID
|
genderId | integer |
Personens könsidentifierare |
|
|
Nationalitets-ID
|
nationalityId | integer |
Personens nationalitet |
|
|
Etnicitets-ID
|
ethnicityId | integer |
Personens etnicitet |
|
|
Civilstånds-ID
|
maritalStatusId | integer |
Personens civilstånd |
|
|
Chefs-ID
|
managerId | integer |
Personens chefsidentifierare (endast chefs-ID eller e-post för chef kan anges) |
|
|
Avdelnings-ID
|
departmentId | integer |
Personens avdelningsidentifierare (endast avdelnings-ID eller avdelningsnamn kan anges) |
|
|
Roll-ID
|
roleId | integer |
Personens anställningsrollidentifierare (endast roll-ID eller rollnamn kan anges) |
|
|
Webbplats-ID
|
mainSiteId | integer |
Platsidentifieraren som personen tillhör |
|
|
Medgivande för nödsituationskontakt
|
emergencyContactConsent | boolean |
Om nödkontakten har gett sitt medgivande för att spara sina uppgifter |
|
|
Namn på nödsituationskontakt
|
emergencyContactName | string |
Namnet på personens nödsituationskontakt |
|
|
Relations-ID för nödsituationskontakt
|
emergencyRelationshipId | integer |
Relationen mellan nödsituationskontakten och personen |
|
|
Telefonnummer för nödsituationskontakt
|
emergencyContactTelephone | string |
Telefonnumret till personens nödsituationskontakt |
|
|
Nödsituationsadress
|
emergencyAddress | string |
Personernas nödsituationsadress |
|
|
Next of Kin-namn
|
nextOfKinName | string |
Namnet på personens närmast anhörig |
|
|
Next of Kin-relations-ID
|
nextOfKinRelationshipId | integer |
Relationen mellan den anhörige och personen |
|
|
Next of Kin-telefon
|
nextOfKinTelephone | string |
Personens närmast anhörigtelefonnummer |
|
|
Uppringningskod
|
dialingCode | string |
Internationell uppringningskod för personens telefonnummer |
|
|
Arbetstillägg
|
workExtension | string |
Personens arbetstilläggsnummer |
|
|
Arbetstelefon
|
telephone | string |
Personens arbetstelefonnummer |
|
|
Personlig mobil
|
personalMobile | string |
Personens personliga mobilnummer |
|
|
Status-ID
|
statusId | integer |
Personens StaffCircle-kontostatus |
|
|
Anställningstyp-ID
|
employmentTypeId | integer |
Personens anställningstyp |
|
|
Kontrakttyp-ID
|
contractTypeId | integer |
Personens kontrakt |
|
|
Kontraktet upphör att gälla
|
contractExpiry | date |
Datumet då anställningsavtalet upphör att gälla |
|
|
Anställningsstatus
|
employmentStatusId | integer |
Personens anställningsstatus |
|
|
Sekundär anställningsstatus
|
secondaryEmploymentStatusId | integer |
Den länkade sekundära anställningsstatusen |
|
|
Sysselsättningsanteckningar
|
employmentNotes | string |
Anställningsanteckningar om personen |
|
|
Medicinska anteckningar
|
medicalNotes | string |
Alla viktiga medicinska anteckningar som är kopplade till personen |
|
|
Är personliga data aktiverade
|
isPersonalDataEnabled | boolean |
Om personuppgifter är aktiverade eller inte |
|
|
Är kontaktdata aktiverat
|
isContactDataEnabled | boolean |
Om Kontaktdata är aktiverat eller inte |
|
|
Tidszon
|
timeZone | string |
Tidszonen som personen bor i |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Person-ID
|
id | integer |
Personens identifierare |
Skapa en ny uppgift
Skapar en ny uppgift och tilldelar den till en användare
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Titel
|
title | True | string |
Aktivitetens rubrik |
|
Prioritets-ID
|
priorityId | integer |
Uppgiftens prioritet. Obligatoriskt om det inte härleds från aktivitetsgruppen |
|
|
Description
|
description | string |
Beskrivning som ges till uppgiften |
|
|
Kalkylblad
|
formId | True | integer |
Kalkylbladet som används i uppgiften |
|
Förfallodatum
|
dueDate | date-time |
Datum då aktiviteten ska slutföras |
|
|
Tilldelad till ID
|
assignedToId | integer |
Vem är uppgiften som tilldelats till. Det går inte att använda om du skickar tilldelad till e-post |
|
|
Chefs-ID
|
managerId | integer |
Vem som hanterar uppgiften. Det går inte att använda om du skickar e-post till hanteraren |
|
|
Aktivitetsgrupps-ID
|
taskGroupId | True | integer |
Den aktivitetsgrupp som aktiviteten är tilldelad till |
|
Tilldelad till e-post
|
assignedToEmail | string |
E-post för vem uppgiften är tilldelad till. Det går inte att använda om du skickar tilldelat till ID |
|
|
E-post för chef
|
managerEmail | string |
E-post för vem som hanterar uppgiften. Det går inte att tilldelas om manager-ID skickas |
|
|
Aktivitetsintervall-ID
|
taskIntervalId | integer |
ID för aktivitetsintervallet. Krävs om aktiviteten upprepas |
|
|
Skicka push-meddelanden
|
push | boolean |
Skickar push-meddelanden om uppgiften |
|
|
Skicka SMS-meddelanden
|
sms | boolean |
Skickar sms-meddelanden om uppgiften |
|
|
Skicka e-postaviseringar
|
boolean |
Skickar e-postaviseringar om uppgiften |
||
|
Skicka Microsoft Teams-meddelanden
|
teams | boolean |
Skickar Microsoft Teams-meddelanden om uppgiften |
|
|
Skicka in appaviseringar
|
inApp | boolean |
Skickar i appaviseringar om uppgiften |
|
|
Tillåt gilla-markeringar
|
allowLikes | boolean |
Tillåt användare att gilla kommentarer om uppgiften |
|
|
Tillåt kommentarer
|
allowComments | boolean |
Tillåt kommentarer om uppgiften |
|
|
Tillåt bilder i kommentarer
|
allowImagesInComments | boolean |
Alla bilder som ska bifogas kommentarer |
|
|
Tillåt dokument
|
allowDocuments | boolean |
Tillåt att dokument bifogas kommentarer |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Identifieraren för uppgiften |
Skapa ett nytt mål
Skapar ett nytt mål
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kompetens
|
categoryId | True | integer |
Den länkade målkompetensen |
|
Titel
|
title | True | string |
Namnet på det nya målet. |
|
Description
|
description | True | string |
Beskrivningen av det nya målet. |
|
Startdatum
|
startDate | True | date-time |
Från när målet mäts |
|
Slutdatum
|
endDate | True | date-time |
Tidsgränsen för målet |
|
Värdetyp
|
valueType | True | string |
Definierar hur målet mäts |
|
Tag
|
tag | string |
En texttagg för användning i sökningar och rapportering. |
|
|
E-post för chef
|
managerEmail | string |
E-postmeddelandet till den chef som ansvarar för att spåra målet. Som standard är person- eller avdelningschefen som standard. Krävs om personen eller avdelningen inte har någon chef eller om målet är ett företagsmål. Används om manager-ID inte har angetts |
|
|
Chefs-ID
|
managerId | integer |
Chefen som ansvarar för att spåra målet. Som standard är person- eller avdelningschefen som standard. Krävs om personen eller avdelningen inte har någon chef eller om målet är ett företagsmål. Används om manager-e-post inte har angetts |
|
|
E-post för person
|
personEmail | string |
E-postadressen till den person som målet är till för. Krävs för att skapa ett personligt mål. Om ingen avdelning eller person tillhandahålls antas målet vara ett företagsmål |
|
|
Person-ID
|
personId | integer |
ID för den person som målet är för. Krävs för att skapa ett personligt mål. Om ingen avdelning eller person tillhandahålls antas målet vara ett företagsmål |
|
|
Avdelningsnamn
|
departmentName | string |
Namnet på den avdelning som målet är till för. Krävs för att skapa ett avdelningsmål. Om ingen avdelning eller person tillhandahålls antas målet vara ett företagsmål |
|
|
Avdelnings-ID
|
departmentId | integer |
ID för den avdelning som målet är för. Krävs för att skapa ett avdelningsmål. Om ingen avdelning eller person tillhandahålls antas målet vara ett företagsmål |
|
|
Företagets mål-ID
|
companyObjectiveId | integer |
En valfri länk till ett företagsmål som det nyligen skapade målet avser |
|
|
Avdelningsmål-ID
|
departmentObjectiveId | integer |
En valfri länk till ett avdelningsmål som det nyligen skapade målet avser |
|
|
Startvärde
|
startValue | double |
Definierar hur målet mäts |
|
|
Target
|
target | double |
Målvärdet som ska uppnås för att målet ska slutföras |
|
|
Tillåt lägg till förlopp
|
allowAddProgress | boolean |
Om true tillåter en person att lägga till själva förloppet kan endast den angivna chefen uppdatera målet. Standard: falskt. |
|
|
Rekurstyp
|
recurType | string |
Om det tillhandahålls är målet återkommande. Definierar tidsenhet för upprepning. |
|
|
Rekursintervall
|
recurInterval | integer |
Hur många dagar/veckor/månader/år kommer målet att återkomma. Krävs om målet upprepas. |
|
|
Kumulativt förlopp
|
cumulativeProgress | boolean |
Anger om förloppet för StaffCircle-klientdelen läggs till som ett inkrementellt värde när du lägger till förlopp från StaffCircle-klientdelen. |
|
|
Skicka push-meddelande
|
push | boolean |
Skickar push-meddelanden. |
|
|
Skicka SMS-meddelande
|
sms | boolean |
Skicka SMS-meddelanden |
|
|
Skicka e-postavisering
|
boolean |
Skickar e-postuppdateringar |
||
|
Skicka Teams-meddelande
|
teams | boolean |
Skickar uppdateringar via Microsoft-team om teams-integrering är aktiverat |
|
|
Skicka i appavisering
|
inApp | boolean |
Skickar InApp-meddelanden |
|
|
Tillåter gilla-markeringar
|
allowLikes | boolean |
Tillåt användare att gilla kommentarer om målet |
|
|
Tillåt kommentarer
|
allowComments | boolean |
Tillåt kommentarer om målet |
|
|
Tillåt bilder i kommentarer
|
allowImagesInComments | boolean |
Alla bilder som ska bifogas kommentarer. |
|
|
Tillåt dokument
|
allowDocuments | boolean |
Tillåt att dokument bifogas kommentarer |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Mål-ID
|
id | integer |
Målidentifieraren |
Skapa ett nytt mål efter mall
Skapar ett nytt mål med hjälp av en målmall
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Målmall
|
objectiveTemplateId | True | integer |
Skapar ett nytt mål från en målmall |
|
Startdatum
|
startDate | True | date-time |
Från när målet mäts |
|
Slutdatum
|
endDate | True | date-time |
Tidsgränsen för målet |
|
E-post för person
|
personEmail | string |
E-postadressen till den person som målet är till för. Krävs för att skapa ett personligt mål. Om ingen avdelning eller person tillhandahålls antas målet vara ett företagsmål |
|
|
Person-ID
|
personId | integer |
ID för den person som målet är för. Krävs för att skapa ett personligt mål. Om ingen avdelning eller person tillhandahålls antas målet vara ett företagsmål |
|
|
Avdelningsnamn
|
departmentName | string |
Namnet på den avdelning som målet är till för. Krävs för att skapa ett avdelningsmål. Om ingen avdelning eller person tillhandahålls antas målet vara ett företagsmål |
|
|
Avdelnings-ID
|
departmentId | integer |
ID för den avdelning som målet är för. Krävs för att skapa ett avdelningsmål. Om ingen avdelning eller person tillhandahålls antas målet vara ett företagsmål |
|
|
E-post för chef
|
managerEmail | string |
E-postmeddelandet till den chef som ansvarar för att spåra målet. Som standard är person- eller avdelningschefen som standard. Krävs om personen eller avdelningen inte har någon chef eller om målet är ett företagsmål. Används om manager-ID inte har angetts |
|
|
Titel
|
title | string |
Åsidosätter namnet på det nya målet. |
|
|
Description
|
description | string |
Åsidosätter beskrivningen av det nya målet. |
|
|
Chefs-ID
|
managerId | integer |
Chefen som ansvarar för att spåra målet. Som standard är person- eller avdelningschefen som standard. Krävs om personen eller avdelningen inte har någon chef eller om målet är ett företagsmål. Används om manager-e-post inte har angetts |
|
|
Företagets mål-ID
|
companyObjectiveId | integer |
En valfri länk till ett företagsmål som det nyligen skapade målet avser |
|
|
Avdelningsmål-ID
|
departmentObjectiveId | integer |
En valfri länk till ett avdelningsmål som det nyligen skapade målet avser |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Mål-ID
|
id | integer |
Identifieraren för det skapade målet |
Sök efter mål
Sök efter mål
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sökrubrik
|
SearchTitle | string |
Lös strängmatchning för sökning baserat på rubrik |
|
|
E-post för person
|
PersonEmail | string |
E-postmeddelandet till den person som målet har tilldelats |
|
|
Tag
|
Tag | string |
Taggen som allokerats till målet |
|
|
Closed
|
Closed | string |
Om målet är stängt. Sant om stängt annars falskt |
|
|
Måltyp
|
ObjectiveType | string |
Typ av mål |
|
|
Från
|
From | date-time |
Målet är aktivt från och med nu |
|
|
Till
|
To | date-time |
Målet är aktivt från och med nu |
|
|
Aktiv vid
|
ActiveAt | date-time |
Målet är aktivt just nu |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
Mål-ID
|
results.id | integer |
Målidentifieraren |
|
Titel
|
results.title | string |
Den rubrik som ges till målet |
|
Description
|
results.description | string |
Beskrivningen av målet |
|
Tag
|
results.tag | string |
Taggen som är associerad med målet |
|
Måltyp
|
results.objectiveType | string |
Typ av mål |
|
Closed
|
results.closed | boolean |
Om målet är stängt |
|
Stängd orsak
|
results.closedReason | string |
Anledningen till att målet har avslutats |
|
Person-ID
|
results.person.id | integer |
Identifieraren för den person som målet är för |
|
Personens förnamn
|
results.person.firstName | string |
Förnamnet på den person som målet är för |
|
Personfamiljenamn
|
results.person.secondName | string |
Familjenamnet på personen i målet är till för |
|
Chefs-ID
|
results.manager.id | integer |
Chefens identifierare |
|
Förnamn för chef
|
results.manager.firstName | string |
Chefens förnamn |
|
Chefsfamiljenamn
|
results.manager.secondName | string |
Chefens familjenamn |
|
Skapat av person-ID
|
results.createdBy.id | integer |
Identifieraren för den person som skapade målet |
|
Skapad av personens förnamn
|
results.createdBy.firstName | string |
Förnamnet på den person som skapade målet |
|
Skapad av personfamiljenamn
|
results.createdBy.secondName | string |
Familjenamnet för den person som skapade målet |
|
Avdelnings-ID
|
results.department.id | integer |
Avdelningsidentifieraren som är kopplad till målet |
|
Avdelningsnamn
|
results.department.name | string |
Namnet på den avdelning som är kopplad till målet |
|
Avdelningsmål-ID
|
results.departmentObjective.id | integer |
identifieraren för avdelningsmålet |
|
Avdelningsmålrubrik
|
results.departmentObjective.title | string |
Avdelningsmålets rubrik |
|
Beskrivning av avdelningsmål
|
results.departmentObjective.description | string |
Beskrivning av avdelningsmål |
|
Företagets mål-ID
|
results.companyObjective.id | integer |
Företagets målidentifierare |
|
Företagets målrubrik
|
results.companyObjective.title | string |
Företagets målrubrik |
|
Beskrivning av företagets mål
|
results.companyObjective.description | string |
Beskrivning av företagets mål |
|
Aktuellt förlopp
|
results.currentProgress | double |
Nuvarande framsteg när det gäller målet |
|
Startdatum
|
results.startDate | string |
Från när målet mäts |
|
Slutdatum
|
results.endDate | string |
Tidsgränsen för målet |
Uppdatera en målpoäng
Uppdaterar ett mål med en ny poäng och en beskrivning
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Mål-ID
|
objectiveId | True | string |
Målet att förloppspoängen ska uppdateras för |
|
Värde
|
value | True | double |
Den aktuella totala förloppet |
|
Är inkrement
|
isIncrement | boolean |
Om värdet är falskt är det aktuella värdet för målet. Om värdet är sant ska värdet läggas till i den befintliga summan |
|
|
Description
|
description | True | string |
En kort beskrivning av de framsteg som gjorts |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Identifieraren för den objektiva förloppsposten |
Utlösare
| När en ny aktivitet läggs till |
Utlöses när en ny aktivitet läggs till |
| när en ny artikel publiceras |
Utlösare när en ny artikel publiceras |
| När en ny frånvaro läggs till |
Utlösare när en ny frånvaro läggs till |
| När en ny granskning läggs till |
Utlöses när en ny granskning läggs till |
| När en ny person läggs till |
Utlöses när en ny person läggs till |
| När ett mål uppdateras |
Utlösare när ett mål uppdateras |
| När ett nytt mål läggs till |
Utlöses när ett nytt mål läggs till |
När en ny aktivitet läggs till
Utlöses när en ny aktivitet läggs till
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string |
Namnet på webhooken |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Post-URL
|
subjectFrontEndUrl | string |
URL:en till posten i StaffCircle |
|
ID-nummer
|
data.id | integer |
Uppgiftens identifierare |
|
Titel
|
data.title | string |
Aktivitetens rubrik |
|
Description
|
data.description | string |
Beskrivningen av uppgiften |
|
Priority
|
data.priority | string |
Uppgiftens prioritet |
|
Aktivitetsgrupps-ID
|
data.groupId | integer |
Uppgiftsgruppens identifierare |
|
Rubrik för aktivitetsgrupp
|
data.groupTitle | string |
Aktivitetsgruppens rubrik |
|
Är Adhoc
|
data.isAdhoc | boolean |
Om det här är en adhoc-uppgift |
|
Skapad av person-ID
|
data.createdByPerson.PersonId | integer |
Identifieraren för den person som skapade uppgiften |
|
Skapad av förnamn
|
data.createdByPerson.FirstName | string |
Förnamnet på den person som skapade uppgiften |
|
Skapad av familjenamn
|
data.createdByPerson.FamilyName | string |
Familjenamnet för den person som skapade uppgiften |
|
Skapad via e-post
|
data.createdByPerson.Email | string |
E-postmeddelandet till den person som skapade uppgiften |
|
Person-ID
|
data.person.PersonId | integer |
Identifieraren för den person som uppgiften är till för |
|
Personens förnamn
|
data.person.FirstName | string |
Förnamnet på den person som uppgiften är till för |
|
Personfamiljenamn
|
data.person.FamilyName | string |
Familjenamnet på den person som uppgiften är till för |
|
E-post för person
|
data.person.Email | string |
E-postmeddelandet till den person som uppgiften gäller |
|
Chefs-ID
|
data.manager.PersonId | integer |
Identifieraren för aktivitetshanteraren |
|
Förnamn för chef
|
data.manager.FirstName | string |
Förnamnet på aktivitetshanteraren |
|
Chefsfamiljenamn
|
data.manager.FamilyName | string |
Namnet på aktivitetshanteraren |
|
E-post för chef
|
data.manager.Email | string |
E-postmeddelandet till chefen för uppgiften |
|
Förfallodatum
|
data.dueDate | date |
När uppgiften förfaller |
|
Skapad på
|
data.createdOn | date-time |
När uppgiften skapades |
|
Formulär-ID
|
data.form.id | integer |
Identifieraren för formuläret som används för att fylla i uppgiften |
|
Formulärrubrik
|
data.form.title | string |
Rubriken på formuläret som används för att fylla i uppgiften |
|
Push-meddelanden
|
data.notificationSettings.push | boolean |
Om I push-meddelanden för uppgiften ska skickas |
|
SMS-meddelanden
|
data.notificationSettings.sms | boolean |
Om i sms-meddelanden för uppgiften ska skickas |
|
E-postaviseringar
|
data.notificationSettings.email | boolean |
Om i e-postaviseringar för uppgiften ska skickas |
|
Microsoft Teams-meddelanden
|
data.notificationSettings.microsoftTeams | boolean |
Om I Microsoft Teams-meddelanden för uppgiften skickas |
|
I appaviseringar
|
data.notificationSettings.inApp | boolean |
Om I appaviseringar för uppgiften ska skickas |
|
Tillåt gilla-markeringar
|
data.contentSettings.allowLikes | boolean |
Om uppgiften tillåter gilla-markeringar |
|
Tillåt kommentarer
|
data.contentSettings.allowComments | boolean |
Om uppgiften tillåter kommentarer |
|
Tillåt bilder i kommentarer
|
data.contentSettings.allowImagesInComments | boolean |
Om uppgiften tillåter bilder i kommentarer |
|
Tillåt dokument
|
data.contentSettings.allowDocuments | boolean |
Om uppgiften tillåter dokument |
när en ny artikel publiceras
Utlösare när en ny artikel publiceras
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
name
|
name | string |
name |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Artikel-URL
|
subjectFrontEndUrl | string |
URL:en till artikeln |
|
ID-nummer
|
data.Id | integer |
Artikelns identifierare |
|
Titel
|
data.Title | string |
Rubriken som ges till artikeln |
|
Sammanfattning
|
data.Summary | string |
Sammanfattningen av artikeln |
|
Tag
|
data.Tag | string |
Taggen som är associerad med artikeln |
|
Prioritetsnamn
|
data.PriorityName | string |
Artikelns prioritet |
|
Skapad på
|
data.CreatedAt | date-time |
Det datum då artikeln först skapades |
|
Everyone
|
data.AudienceDto.Everyone | boolean |
Om artikeln publiceras till alla |
|
Personer
|
data.AudienceDto.Persons | array of object | |
|
Persontagg
|
data.AudienceDto.Persons.Tag | string |
Tagg för målperson |
|
Id
|
data.AudienceDto.Persons.Id | integer |
Tagg-ID |
|
Webbplatser
|
data.AudienceDto.Sites | array of object | |
|
Webbplatstagg
|
data.AudienceDto.Sites.Tag | string |
Tagg för målwebbplats |
|
Id
|
data.AudienceDto.Sites.Id | integer |
Tagg-ID |
|
Avdelningar
|
data.AudienceDto.Departments | array of object | |
|
Avdelningstagg
|
data.AudienceDto.Departments.Tag | string |
Tagg för målavdelning |
|
Id
|
data.AudienceDto.Departments.Id | integer |
Tagg-ID |
|
Skapad av ID
|
data.CreatedByPerson.PersonId | integer |
Identifieraren för den person som skapade artikeln |
|
Skapad av förnamn
|
data.CreatedByPerson.FirstName | string |
Förnamnet på den person som skapade artikeln |
|
Skapad av familjenamn
|
data.CreatedByPerson.FamilyName | string |
Familjenamnet för den person som skapade artikeln |
|
Skapad via e-post
|
data.CreatedByPerson.Email | string |
E-postadressen till den person som skapade artikeln |
|
Ändrades
|
data.ModifiedAt | date-time |
När artikeln senast ändrades |
|
Ändrad av ID
|
data.ModifiedByPerson.PersonId | integer |
Identifieraren för den person som senast ändrade artikeln |
|
Ändrad efter förnamn
|
data.ModifiedByPerson.FirstName | string |
Förnamnet på den person som senast ändrade artikeln |
|
Ändrad efter familjenamn
|
data.ModifiedByPerson.FamilyName | string |
Familjenamnet på den person som senast ändrade artikeln |
|
Ändrad via e-post
|
data.ModifiedByPerson.Email | string |
E-postadressen till den person som senast ändrade artikeln |
|
Publiceringsdatum
|
data.PublishedDate | date-time |
När artikeln publicerades |
|
Artikelinnehåll
|
data.ArticleContent | string |
HTML-innehållet i artikeln |
|
Artikelinnehållstext
|
data.ArticleContentText | string |
Artikelinnehållet i oformaterad text |
|
Huvudbild-ID
|
data.MainImageId | integer |
ID:t till en bild som ska användas som artiklarnas huvudbild i flödet. |
När en ny frånvaro läggs till
Utlösare när en ny frånvaro läggs till
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string |
Namnet på webhooken |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Post-URL
|
subjectFrontEndUrl | string |
URL:en för posten i StaffCircle |
|
ID-nummer
|
data.id | integer |
ID:et för frånvaron |
|
Person-ID
|
data.requestedForPerson.PersonId | integer |
Identifieraren för den person som frånvarobegäran gäller |
|
Personens förnamn
|
data.requestedForPerson.FirstName | string |
Förnamnet på den person som frånvarobegäran gäller |
|
Personfamiljenamn
|
data.requestedForPerson.FamilyName | string |
Familjenamnet på den person som frånvarobegäran gäller |
|
E-post för person
|
data.requestedForPerson.Email | string |
E-postadressen till den person som frånvarobegäran gäller |
|
Enhetstyp
|
data.unitType | string |
Enhetstypen för frånvarobegäran (timmar, dagar) |
|
Antal timmar
|
data.numberOfHours | double |
Antalet timmar som har begärts av |
|
Deldag
|
data.partialDay | string |
Om en deldag har begärts av (morgon, eftermiddag) |
|
Startdatum
|
data.start | date-time |
När frånvaron börjar |
|
Slutdatum
|
data.end | date-time |
När frånvaron upphör |
|
Typ-ID
|
data.typeId | integer |
Identifieraren för den typ av frånvaro som begärs |
|
Typ
|
data.type | string |
Den typ av frånvaro som begärs |
|
Undertyps-ID
|
data.subTypeId | integer |
Identifieraren för den undertyp av frånvaro som begärs |
|
Policy-ID
|
data.policyId | integer |
Identifieraren för den frånvaropolicy som den anställde är på |
|
Reason
|
data.reason | string |
Orsaken till frånvarobegäran |
|
Skapad på
|
data.createdAt | date-time |
När frånvarobegäran gjordes |
|
Skapad av ID
|
data.createdByPerson.PersonId | integer |
Identifieraren för den person som skapade frånvarobegäran |
|
Skapad av förnamn
|
data.createdByPerson.FirstName | string |
Förnamnet på den person som skapade frånvarobegäran |
|
Skapad av familjenamn
|
data.createdByPerson.FamilyName | string |
Familjenamnet för den person som skapade frånvarobegäran |
|
Skapad via e-post
|
data.createdByPerson.Email | string |
E-postadressen till den person som skapade frånvarobegäran |
|
Godkännandestatus
|
data.approvalDetails.status | string |
Status för godkännandet (väntande, godkänd, nekad) |
|
Godkänd den
|
data.approvalDetails.approvedAt | date-time |
När frånvaron godkändes |
|
Godkännandesvar
|
data.approvalDetails.response | string |
Svaret från godkännaren |
|
Godkänd av ID
|
data.approvalDetails.approvedByPerson.PersonId | integer |
Identifieraren för den person som godkände frånvaron |
|
Godkänd av förnamn
|
data.approvalDetails.approvedByPerson.FirstName | string |
Förnamnet på den person som godkände frånvaron |
|
Godkänd efter familjenamn
|
data.approvalDetails.approvedByPerson.FamilyName | string |
Namnet på den person som godkände frånvaron |
|
Godkänd via e-post
|
data.approvalDetails.approvedByPerson.Email | string |
E-postadressen till den person som godkände frånvaron |
|
Chefs-ID
|
data.manager.PersonId | integer |
Identifieraren för den chef som deltar i frånvarobegäran |
|
Förnamn för chef
|
data.manager.FirstName | string |
Förnamnet på den chef som deltar i frånvarobegäran |
|
Chefsfamiljenamn
|
data.manager.FamilyName | string |
Familjenamnet på den chef som deltar i frånvarobegäran |
|
E-post för chef
|
data.manager.Email | string |
E-postadressen till den chef som deltar i frånvarobegäran |
När en ny granskning läggs till
Utlöses när en ny granskning läggs till
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string |
Namnet på webhooken |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Post-URL
|
subjectFrontEndUrl | string |
URL:en för posten i StaffCircle |
|
ID-nummer
|
data.id | integer |
Granskningsidentifieraren |
|
Föregående gransknings-ID
|
data.previousReviewId | integer |
Identifieraren för föregående granskning för den här granskaren |
|
Chefs-ID
|
data.manager.PersonId | integer |
Identifieraren för den chef som är associerad med granskningen |
|
Förnamn för chef
|
data.manager.FirstName | string |
Förnamnet på den chef som är associerad med granskningen |
|
Chefsfamiljenamn
|
data.manager.FamilyName | string |
Familjenamnet på den chef som är associerad med granskningen |
|
E-post för chef
|
data.manager.Email | string |
E-postadressen till den chef som är associerad med granskningen |
|
internalReviewerPersonIds
|
data.internalReviewerPersonIds | array of integer |
internalReviewerPersonIds |
|
Gransknings-ID
|
data.person.PersonId | integer |
Granskningsobjektets identifierare |
|
Reviewee Förnamn
|
data.person.FirstName | string |
Granskningsobjektets förnamn |
|
Reviewee Family Name
|
data.person.FamilyName | string |
Granskarens familjenamn |
|
E-post för granskare
|
data.person.Email | string |
Granskningsobjektets e-postadress |
|
Titel
|
data.title | string |
Rubriken som ges till recensionen |
|
Description
|
data.description | string |
Beskrivningen som ges till granskningen |
|
Granskningstyp
|
data.reviewType | string |
Typ av granskning |
|
Förfaller den
|
data.dueOn | date-time |
När granskningen är förfallen |
|
attachedDocumentIds
|
data.attachedDocumentIds | array of integer |
attachedDocumentIds |
|
linkedObjectives
|
data.linkedObjectives | array of integer |
linkedObjectives |
|
Utvärderingsmalls-ID
|
data.appraisalSummary.personAppraisalTemplateId | integer |
Utvärderingsmallen som används för att skapa utvärderingen |
|
Aktuell poäng
|
data.scores.currentScore | double |
Recensionernas aktuella poäng |
|
Skapad på
|
data.createdAt | date-time |
När granskningen skapades |
|
Skapad av ID
|
data.createdByPerson.PersonId | integer |
Identifieraren för den person som skapade granskningen |
|
Skapad av förnamn
|
data.createdByPerson.FirstName | string |
Förnamnet på den person som skapade granskningen |
|
Skapad av familjenamn
|
data.createdByPerson.FamilyName | string |
Familjenamnet för den person som skapade granskningen |
|
Skapad via e-post
|
data.createdByPerson.Email | string |
E-postadressen till den person som skapade granskningen |
|
Tillåt gilla-markeringar
|
data.contentSettings.allowLikes | boolean |
Om gilla-markeringar tillåts |
|
Tillåt kommentarer
|
data.contentSettings.allowComments | boolean |
Om kommentarer tillåts i granskningen |
|
Tillåt bilder i kommentarer
|
data.contentSettings.allowImagesInComments | boolean |
Om bilder tillåts i kommentarer |
|
Tillåt dokument
|
data.contentSettings.allowDocuments | boolean |
Om dokument kan bifogas till granskningen |
|
Push-meddelanden
|
data.notificationSettings.push | boolean |
Om push-meddelanden ska skickas |
|
SMS-meddelanden
|
data.notificationSettings.sms | boolean |
Om sms-meddelanden ska skickas |
|
E-postavisering
|
data.notificationSettings.email | boolean |
Om e-postaviseringar ska skickas |
|
Microsoft Teams-meddelanden
|
data.notificationSettings.microsoftTeams | boolean |
Om microsoft Teams-meddelanden ska skickas |
|
I appaviseringar
|
data.notificationSettings.inApp | boolean |
Om appaviseringar ska skickas |
När en ny person läggs till
Utlöses när en ny person läggs till
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string |
Namnet på webhooken |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Post-URL
|
subjectFrontEndUrl | string |
URL:en till posten i StaffCircle |
|
Person-ID
|
data.id | integer |
Identifieraren som representerar personen |
|
Förnamn
|
data.givenName | string |
Personens förnamn |
|
Mellannamn
|
data.middleName | string |
Personens mellannamn |
|
Efternamn
|
data.familyName | string |
Personens efternamn |
|
Kallas
|
data.knownAs | string |
Vilket namn personen gillar att bli känd som |
|
Födelsedatum
|
data.dateOfBirth | date |
Personens födelsedatum |
|
Personlig e-post
|
data.contactDetails.personalEmail | string |
Personens personliga e-postadress |
|
E-post för arbete
|
data.contactDetails.workEmail | string |
Personens e-postadress till arbetet |
|
Work Mobile
|
data.contactDetails.workMobile | string |
Personens arbetsmobilnummer |
|
Personlig mobil
|
data.contactDetails.personalMobile | string |
Personens personliga mobilnummer |
|
Hemtelefon
|
data.contactDetails.homeTelephone | string |
Personens hemtelefonnummer |
|
Arbetstelefon
|
data.contactDetails.workTelephone | string |
Personens arbetstelefonnummer |
|
Arbetstelefon
|
data.contactDetails.workExtension | string |
Personens arbetstilläggsnummer |
|
Adressrad 1
|
data.address.addressLine1 | string |
Personens första rad i sin hemadress |
|
Adressrad 2
|
data.address.addressLine2 | string |
Personens första rad i sin hemadress |
|
Stad
|
data.address.town | string |
Personens bostad |
|
Postnummer
|
data.address.postCode | string |
Personens postnummer |
|
Namn på nödsituationskontakt
|
data.emergencyContact.emergencyContactName | string |
Namnet på personens nödsituationskontakt |
|
Telefonnummer för nödsituationskontakt
|
data.emergencyContact.emergencyContactTelephone | string |
Telefonnumret till personens nödsituationskontakt |
|
Relations-ID för nödsituationskontakt
|
data.emergencyContact.emergencyRelationshipId | integer |
Relationen mellan nödsituationskontakten och personen |
|
Medgivande för nödsituationskontakt
|
data.emergencyContact.emergencyContactConsent | boolean |
Om nödkontakten har gett sitt medgivande för att spara sina uppgifter |
|
Adress för nödsituationskontakt
|
data.emergencyContact.emergencyAddress | string |
Kontaktadress för personer med nödsituation |
|
Medicinska anteckningar
|
data.emergencyContact.emergencyMedicalNotes | string |
Alla viktiga medicinska anteckningar som är kopplade till personen |
|
Next of Kin Name
|
data.nextOfKin.Name | string |
Personens närmast anhörig |
|
Next of Kin Telephone
|
data.nextOfKin.Telephone | string |
Personens närmast anhörigtelefonnummer |
|
Next of Kin Relationship ID
|
data.nextOfKin.RelationshipId | string |
Relationen mellan den anhörige och personen |
|
Sysselsättningsanteckningar
|
data.employeeDetails.employmentNotes | string |
Anställningsanteckningar om personen |
|
Tag
|
data.employeeDetails.tag | string |
Taggen som kan användas för att referera till personen i hela StaffCircle-plattformen |
|
Startdatum
|
data.employeeDetails.startDate | string |
När personens anställning började |
|
Webbplats-ID
|
data.employeeDetails.siteId | integer |
Platsidentifieraren som personen tillhör |
|
grupp-id
|
data.employeeDetails.groupId | integer |
Den grupp som personen tillhör |
|
Avdelnings-ID
|
data.employeeDetails.departmentId | integer |
Den avdelning som personen tillhör |
|
Chefs-ID
|
data.employeeDetails.manager.PersonId | integer |
Identifieraren för parsonens chef |
|
Chefens förnamn
|
data.employeeDetails.manager.FirstName | string |
Förnamnet på personens chef |
|
Chefens familjenamn
|
data.employeeDetails.manager.FamilyName | string |
Familjenamnet på personens chef |
|
E-post för chef
|
data.employeeDetails.manager.Email | string |
Personens chefs e-postadress |
|
Kontostatus
|
data.accountStatus | integer |
Personens StaffCircle-kontostatus |
När ett mål uppdateras
Utlösare när ett mål uppdateras
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string |
Namnet på webhooken |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Post-URL
|
subjectFrontEndUrl | string |
URL:en till posten i StaffCircle |
|
ID-nummer
|
data.id | integer |
Identifieraren för den objektiva förloppsposten |
|
Mål-ID
|
data.objectiveId | integer |
Målet att den här förloppsposten är associerad med |
|
Värde
|
data.value | double |
Det totala förloppsvärdet för objektet |
|
Description
|
data.description | string |
Beskrivningen har lagts till i målförloppsposten |
|
Skapad på
|
data.createdAt | date-time |
När förloppsposten skapades |
|
Skapad av person-ID
|
data.createdByPerson.PersonId | integer |
Identifieraren för den person som skapade förloppsmålsposten |
|
Skapad av förnamn
|
data.createdByPerson.FirstName | string |
Förnamnet på den person som skapade den objektiva förloppsposten |
|
Skapad av familjenamn
|
data.createdByPerson.FamilyName | string |
Familjenamnet för den person som skapade förloppsposten för målet |
|
Skapad via e-post
|
data.createdByPerson.Email | string |
E-postadressen till den person som skapade den objektiva förloppsposten |
|
Skicka meddelanden
|
data.sendNotifications | boolean |
Anger om meddelanden som skickas |
När ett nytt mål läggs till
Utlöses när ett nytt mål läggs till
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string |
Namnet på webhooken |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Post-URL
|
subjectFrontEndUrl | string |
URL:en till posten i StaffCircle |
|
Mål-ID
|
data.id | integer |
Målets identifierare |
|
Målmall
|
data.templateId | integer |
Skapar ett nytt mål från en målmall |
|
Chefs-ID
|
data.manager.PersonId | integer |
Personens chefs identifierare |
|
Förnamn för chef
|
data.manager.FirstName | string |
Personens chefs förnamn |
|
Chefsfamiljenamn
|
data.manager.FamilyName | string |
Personens chefs familjenamn |
|
E-post för chef
|
data.manager.Email | string |
Personens chefs e-postadress |
|
Personidentifierare
|
data.person.PersonId | integer |
Personens identifierare som är kopplad till målet |
|
Personens förnamn
|
data.person.FirstName | string |
Personens förnamn som är kopplat till målet |
|
Personfamiljenamn
|
data.person.FamilyName | string |
Personens familjenamn som är kopplat till målet |
|
E-post för person
|
data.person.Email | string |
Personens e-postadress som är länkad till målet |
|
Titel
|
data.title | string |
Namnet på det nya målet |
|
Description
|
data.description | string |
Beskrivningen av det nya målet |
|
Värdetyp
|
data.valueType | string |
Definierar hur målet mäts |
|
Tag
|
data.tag | string |
En texttagg för användning i sökningar och rapportering |
|
Kategori
|
data.category | string |
Målkategoriidentifierare |
|
Startdatum
|
data.startDate | date-time |
Från när målet mäts |
|
Slutdatum
|
data.endDate | string |
Tidsgränsen för målet |
|
Senaste förloppsdatum
|
data.lastProgressDate | date-time |
Det datum då det gjordes framsteg när det gäller målet |
|
stängd
|
data.closed | boolean |
stängd |
|
Tillåt lägg till förlopp
|
data.allowAddProgress | boolean |
Om true tillåter att en person lägger till själva förloppet kan endast den angivna chefen uppdatera målet |
|
Push-meddelande
|
data.notificationSettings.push | boolean |
Skickar push-meddelanden. |
|
SMS-meddelande
|
data.notificationSettings.sms | boolean |
Skicka SMS-meddelanden |
|
E-postavisering
|
data.notificationSettings.email | boolean |
Skickar e-postuppdateringar |
|
Teams-meddelande
|
data.notificationSettings.microsoftTeams | boolean |
Skickar uppdateringar via Microsoft-team om teams-integrering är aktiverat |
|
I appmeddelande
|
data.notificationSettings.inApp | boolean |
Skickar InApp-meddelanden |
|
Tillåter gilla-markeringar
|
data.contentSettings.allowLikes | boolean |
Tillåt användare att gilla kommentarer om målet |
|
Tillåt kommentarer
|
data.contentSettings.allowComments | boolean |
Tillåt kommentarer om målet |
|
Tillåt bilder i kommentarer
|
data.contentSettings.allowImagesInComments | boolean |
Alla bilder som ska bifogas kommentarer. |
|
Tillåt dokument
|
data.contentSettings.allowDocuments | boolean |
Tillåt att dokument bifogas kommentarer |
|
Skapad vid
|
data.createdAt | date-time |
När målet har skapats |
|
Skapat av person-ID
|
data.createdByPerson.PersonId | integer |
Identifieraren för den person som skapade målet |
|
Skapad av personens förnamn
|
data.createdByPerson.FirstName | string |
Förnamnet på den person som skapade målet |
|
Skapad av personfamiljenamn
|
data.createdByPerson.FamilyName | string |
Familjenamnet för den person som skapade målet |
|
E-post skapad av person
|
data.createdByPerson.Email | string |
E-postadressen till den person som skapade målet |
|
Aktuellt förlopp
|
data.currentProgress | double |
Nuvarande framsteg när det gäller målet |
|
Startvärde
|
data.startValue | double |
Definierar hur målet mäts |
|
Target
|
data.targetValue | double |
Målvärdet som ska uppnås för att målet ska slutföras |