StaffCircle (Vorschau)
StaffCircle ist eine Erfolgsplattform für Mitarbeiter, die Unternehmenskultur mit Performance Management kombiniert, um leistungsstarke Teams auch in verteilten Arbeitsumgebungen zu schaffen. StafffCircle umfasst Objective, Reviews, Values und Feedback, die mit Ihrem Kompetenzframework verknüpft sind. Fördern Sie Engagement und Leistung mit tiefem Einblick.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | StaffCircle Support |
| URL | https://www.staffcircle.com/contact-us/ |
| support@staffcircle.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | StaffCircle |
| Webseite | https://www.staffcircle.com/ |
| Datenschutzrichtlinie | https://www.staffcircle.com/privacy-policy/ |
| Kategorien | Kommunikation; Personalabteilung |
StaffCircle hilft Organisationen dabei, ihre Remotemitarbeiter zu verwalten, indem sie das Leistungsmanagement, Comms und Culture verbessern. Sie können eine Verbindung mit StaffCircle herstellen, um Ihre One2one-Rezensionen, Leistungsziele, Okrs, Echtzeitfeedback, Auszeichnungen und Anerkennung zu verwalten. Sie können verschiedene Aktionen ausführen, z. B. Leistungsziele erstellen oder aktualisieren, Auszeichnungen zuweisen, Artikel und Benachrichtigungen erstellen, Benutzerinformationen aktualisieren und vieles mehr.
Voraussetzungen
Um diesen Connector zu verwenden, müssen Sie Zugriff auf ein StaffCircle-Konto haben. StaffCircle ist ein kostenpflichtiger Abonnementplan. Wenn Sie keinen Zugriff auf ein StaffCircle-Konto haben, finden Sie hier weitere Details.
So erhalten Sie Anmeldeinformationen
Wenn Sie Zugriff auf ein StaffCircle-Konto haben, verfügen Sie bereits über die Anmeldeinformationen, die Sie für die Verwendung dieses Connectors benötigen. Beim Erstellen einer Verbindung für den StaffCircle-Connector werden Sie aufgefordert, Ihren Benutzernamen und Ihr Kennwort einzugeben. Hier können alle StaffCircle-Kontoanmeldeinformationen verwendet werden. Es ist wichtig zu beachten, dass der Connector im Kontext der bereitgestellten Anmeldeinformationen ausgeführt wird. Dazu gehört auch die Berücksichtigung von Sicherheitsberechtigungen. Dies bedeutet, dass Sie sicherstellen müssen, dass das von Ihnen verwendete StaffCircle-Konto über die richtigen Berechtigungen zum Ausführen der Aktion verfügt, die im Connector ausgelöst wird.
Erste Schritte mit Ihrem Connector
Die ersten Schritte mit dem StaffCircle-Connector sind einfach, Sie benötigen lediglich ein StaffCircle-Konto. Ihre Benutzeranmeldeinformationen können verwendet werden, um eine Verbindung mit dem StaffCircle-Connector zu erstellen. Sobald Sie fertig sind, können Sie einen unserer im Connector definierten Trigger verwenden, um mit dem Auslösen automatisierter Workflows aus Ereignissen in Ihrer StaffCircle-Instanz zu beginnen.
Hier sind einige Beispielworkflows
- Lösen Sie einen Workflow aus, wenn ein Artikel in StaffCircle veröffentlicht wird, und senden Sie eine Benachrichtigung über den Artikel an eine Chatanwendung wie Slack.
- Lösen Sie einen Workflow aus, wenn einem neuen Mitarbeiter StaffCircle hinzugefügt wird, und steuern Sie einen Onboardingprozess, der Möglicherweise Kommunikationen wie E-Mails an den neuen Mitarbeiter umfasst.
StaffCircle verfügt über viele Webhooks, die nicht alle im Connector als Trigger verfügbar gemacht werden. Wenn Sie keinen Trigger finden können, der Ihren Anforderungen entspricht, sollten Sie unsere Webhooks anzeigen. Unsere Webhooks finden Sie in der StaffCircle-Webanwendung unter dem Integrationsbereich der Einstellungen. Sie können den Ablauftrigger "Wenn eine HTTP-Anforderung empfangen wird" verwenden, um eine URL zu generieren, die dem StaffCircle-Webhook zum Auslösen eines Workflows übergeben werden kann.
Ein Beispiel für einen solchen Workflow wäre
- Wenn eine Feiertagsanforderung für einen Mitarbeiter gestellt wird, erstellen Sie ein Outlook-Kalenderereignis.
StaffCircle hat eine Sammlung von Aktionen zur Verbesserung der Kommunikation und des objektiven Managements innerhalb eines Unternehmens zur Verfügung gestellt. Aktionen wie "Neue Warnung erstellen" können verwendet werden, um das Senden von Nachrichten über mehrere Kanäle auszulösen, die StaffCircle unterstützt, z. B. E-Mail, SMS, MS Teams, In App und Pushbenachrichtigungen. Auf diese Weise können Ihre Teams über wichtige Ereignisse informiert werden, die in anderen Anwendungen auftreten.
Die Zielaktionen können verwendet werden, um die Nachverfolgung von KPIs zu automatisieren. Wenn Ereignisse in anderen Anwendungen auftreten, z. B. eine Chance zu gewinnen, können Sie Ihre Ziele aktualisieren, die in StaffCircle mit dem Wert des Deals festgelegt sind.
StaffCircle hat Komfortaktionen wie "Person per E-Mail abrufen" bereitgestellt, um die Verknüpfung von Mitarbeitern mit anderen Aktionen wie "Neue Aufgabe erstellen" zu erleichtern.
Support
Wenn Sie Schwierigkeiten beim Einrichten des StaffCircle-Connectors haben oder Funktionalität benötigen, um Ihre geschäftlichen Anforderungen zu erfüllen, wenden Sie sich bitte an uns unter support@staffcircle.com
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Aktualisieren einer Zielbewertung |
Aktualisiert ein Ziel mit einer neuen Bewertung und einer Beschreibung |
| Erstellen einer neuen Aufgabe |
Erstellt eine neue Aufgabe und weist sie einem Benutzer zu. |
| Erstellen einer neuen Benachrichtigung |
Erstellt eine neue Warnung, die über mehrere Kommunikationskanäle an StaffCircle-Benutzer verteilt werden kann |
| Erstellen einer neuen Person |
Erstellt eine Person |
| Erstellen eines neuen Artikels |
Erstellt einen neuen Artikel, der über mehrere Kommunikationskanäle an StaffCircle-Benutzer verteilt werden kann |
| Erstellen eines neuen Ziels |
Erstellt ein neues Ziel |
| Erstellen eines neuen Ziels nach Vorlage |
Erstellt ein neues Ziel mithilfe einer Zielvorlage. |
| Nach Zielen suchen |
Nach Zielen suchen |
| Person per E-Mail abrufen |
Versucht, einen Personendatensatz per E-Mail zu finden |
Aktualisieren einer Zielbewertung
Aktualisiert ein Ziel mit einer neuen Bewertung und einer Beschreibung
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ziel-ID
|
objectiveId | True | string |
Das Ziel, dass die Fortschrittsbewertung aktualisiert werden soll |
|
Wert
|
value | True | double |
Der aktuelle Gesamtfortschritt |
|
Ist erhöht
|
isIncrement | boolean |
Wenn "false" übergeben wird, ist der übergebene Wert der aktuelle Wert des Ziels. Wenn "true" ist, sollte der Wert der vorhandenen Summe hinzugefügt werden. |
|
|
Description
|
description | True | string |
Eine kurze Beschreibung der erzielten Fortschritte |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Der Bezeichner für den Zielfortschrittsdatensatz |
Erstellen einer neuen Aufgabe
Erstellt eine neue Aufgabe und weist sie einem Benutzer zu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Title
|
title | True | string |
Der Titel des Vorgangs |
|
Prioritäts-ID
|
priorityId | integer |
Priorität des Vorgangs. Erforderlich, wenn nicht von der Aufgabengruppe abgeleitet |
|
|
Description
|
description | string |
Beschreibung des Vorgangs |
|
|
Arbeitsblatt
|
formId | True | integer |
Das arbeitsblatt, das in der Aufgabe verwendet wird |
|
Fälligkeitsdatum
|
dueDate | date-time |
Datum, an dem der Vorgang für den Abschluss fällig ist |
|
|
Zugewiesen an ID
|
assignedToId | integer |
Wem die Aufgabe zugewiesen ist. Kann nicht verwendet werden, wenn "Zugewiesen an E-Mail" übergeben wird |
|
|
Manager-ID
|
managerId | integer |
Wer verwaltet die Aufgabe. Kann nicht verwendet werden, wenn Manager-E-Mail übergeben wird |
|
|
Aufgabengruppen-ID
|
taskGroupId | True | integer |
Die Aufgabengruppe, der die Aufgabe zugewiesen ist |
|
E-Mail zugewiesen
|
assignedToEmail | string |
E-Mail der Person, der die Aufgabe zugewiesen ist. Kann verwendet werden, wenn "Zugewiesen an ID" übergeben wird |
|
|
Manager-E-Mail
|
managerEmail | string |
E-Mail von Personen, die die Aufgabe verwalten. Kann nicht zugewiesen werden, wenn die Manager-ID übergeben wird |
|
|
Vorgangsintervall-ID
|
taskIntervalId | integer |
ID des Vorgangsintervalls. Erforderlich, wenn der Vorgang rekursiert |
|
|
Pushbenachrichtigungen senden
|
push | boolean |
Sendet Pushbenachrichtigungen über die Aufgabe |
|
|
SMS-Benachrichtigungen senden
|
sms | boolean |
Sendet SMS-Benachrichtigungen über die Aufgabe |
|
|
Senden von E-Mail-Benachrichtigungen
|
boolean |
Sendet E-Mail-Benachrichtigungen über die Aufgabe |
||
|
Microsoft Teams-Benachrichtigungen senden
|
teams | boolean |
Sendet Microsoft Teams-Benachrichtigungen über die Aufgabe |
|
|
Senden von App-Benachrichtigungen
|
inApp | boolean |
Sendet in App-Benachrichtigungen über die Aufgabe |
|
|
Gefällt mir zulassen
|
allowLikes | boolean |
Zulassen, dass Benutzer Kommentare zu der Aufgabe liken |
|
|
Kommentare zulassen
|
allowComments | boolean |
Kommentare zu der Aufgabe zulassen |
|
|
Bilder in Kommentaren zulassen
|
allowImagesInComments | boolean |
Alle Bilder, die an Kommentare angefügt werden sollen |
|
|
Dokumente zulassen
|
allowDocuments | boolean |
Zulassen, dass Dokumente an Kommentare angefügt werden |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Der Bezeichner für den Vorgang |
Erstellen einer neuen Benachrichtigung
Erstellt eine neue Warnung, die über mehrere Kommunikationskanäle an StaffCircle-Benutzer verteilt werden kann
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Title
|
title | True | string |
Der Titel der Warnung |
|
Priority
|
priority | True | string |
Welche Priorität hat die Warnung? |
|
Zusammenfassung
|
summary | string |
Der Hauptinhalt der Warnung |
|
|
An jeden senden
|
everyone | boolean |
Sollte diese Warnung an alle Benutzer im Unternehmen gesendet werden |
|
|
An Abteilungstags senden
|
departmentTags | string |
Eine durch Trennzeichen getrennte Liste von Abteilungstags, die die Warnung erhalten sollen. Verwenden Sie nicht, wenn "An jeden senden" auf "true" festgelegt ist. |
|
|
An Personentags senden
|
peopleTags | string |
Eine durch Trennzeichen getrennte Liste von Personentags, die die Warnung erhalten sollen. Verwenden Sie nicht, wenn "An jeden senden" auf "true" festgelegt ist. |
|
|
An Gruppentags senden
|
groupTags | string |
Eine durch Trennzeichen getrennte Liste von Gruppentags, die die Warnung erhalten sollen. Verwenden Sie nicht, wenn "An jeden senden" auf "true" festgelegt ist. |
|
|
An Websitetags senden
|
siteTags | string |
Eine durch Trennzeichen getrennte Liste von Websitetags, die die Warnung erhalten sollen. Verwenden Sie nicht, wenn "An jeden senden" auf "true" festgelegt ist. |
|
|
Pushbenachrichtigungen senden
|
push | boolean |
Gibt an, ob Benutzer über Pushbenachrichtigungen benachrichtigt werden sollen |
|
|
SMS-Benachrichtigungen senden
|
sms | boolean |
Gibt an, ob Benutzer über SMS-Benachrichtigungen benachrichtigt werden sollen |
|
|
E-Mail-Benachrichtigung senden
|
boolean |
Gibt an, ob die Benachrichtigung per E-Mail gesendet werden soll |
||
|
In App-Benachrichtigung senden
|
inApp | boolean |
Gibt an, ob Benutzer über App-Benachrichtigungen benachrichtigt werden sollen |
|
|
Microsoft Teams-Benachrichtigung senden
|
teams | boolean |
Gibt an, ob Benutzer über Microsoft Teams-Benachrichtigungen benachrichtigt werden sollen |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Der Bezeichner für die Warnung |
Erstellen einer neuen Person
Erstellt eine Person
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorname
|
firstName | True | string |
Vorname der Person |
|
Zweiter Name
|
secondName | True | string |
Der zweite Name der Person |
|
Email
|
True | string |
Die geschäftliche E-Mail-Adresse der Person |
|
|
Mobiltelefon
|
mobile | True | string |
Die Mobiltelefonnummer der Person |
|
Geburtsdatum
|
dateOfBirth | True | date |
Geburtsdatum der Person |
|
Startdatum
|
startDate | True | string |
Wenn die Beschäftigung der Person begonnen hat |
|
Adresszeile 1
|
addressLine1 | string |
Die erste Zeile ihrer Privatadresse |
|
|
Adresszeile 2
|
addressLine2 | string |
Die zweite Zeile ihrer Privatadresse |
|
|
Stadt
|
town | string |
Die Residenzstadt der Person |
|
|
Postleitzahl
|
postCode | string |
Postcode der Person |
|
|
County Name
|
countyName | string |
Der Wohnsitz der Person |
|
|
Ländername
|
countryName | string |
Wohnsitzland der Person |
|
|
Titelname
|
titleName | string |
Der Titel der Person |
|
|
Zweitname
|
middleName | string |
Vorname der Person |
|
|
Persönliche Email
|
homeEmail | string |
Die persönliche E-Mail-Adresse der Person |
|
|
Telefon (privat)
|
homeTelephone | string |
Die private Telefonnummer der Person |
|
|
Tag
|
tag | string |
Das Tag, mit dem auf die Person auf der gesamten StaffCircle-Plattform verwiesen werden kann |
|
|
Manager-E-Mail
|
managerEmail | string |
Die E-Mail-Adresse des Vorgesetzten der Person. Dies kann verwendet werden, um einen Vorgesetzten mit einer Person zu verknüpfen. |
|
|
Abteilungsname
|
departmentName | string |
Der Name der Abteilung, zu der die Person gehört |
|
|
Rollenname
|
roleName | string |
Die Rolle der Person. Dies kann verwendet werden, um eine Rolle mit einer Person zu verknüpfen. |
|
|
Bekannt als
|
knownAs | string |
Der Name, den die Person bevorzugt, wird als "Bekannt" bezeichnet. |
|
|
Profilbild-URL
|
avatarURL | string |
Profilbild der Person |
|
|
Titel-ID
|
titleId | integer |
Der Titel der Person |
|
|
County-ID
|
countyId | integer |
Der Wohnsitz der Person |
|
|
Länder-ID
|
countryId | integer |
Wohnsitzland der Person |
|
|
Gender ID
|
genderId | integer |
Der Geschlechtsbezeichner der Person |
|
|
Staatsangehörigkeits-ID
|
nationalityId | integer |
Die Staatsangehörigkeit der Person |
|
|
Ethnizitäts-ID
|
ethnicityId | integer |
Die ethnische Zugehörigkeit der Person |
|
|
Familienstatus-ID
|
maritalStatusId | integer |
Der Familienstatus der Person |
|
|
Manager-ID
|
managerId | integer |
Die Manager-ID der Person (nur Manager-ID oder Manager-E-Mail kann eingegeben werden) |
|
|
Abteilungs-ID
|
departmentId | integer |
Der Abteilungsbezeichner der Person (nur Abteilungs-ID oder Abteilungsname kann eingegeben werden) |
|
|
Rollen-ID
|
roleId | integer |
Die Rollen-ID der Person (nur Rollen-ID oder Rollenname kann eingegeben werden) |
|
|
ID der Website
|
mainSiteId | integer |
Der Websitebezeichner, zu dem die Person gehört |
|
|
Zustimmung des Notfallkontakts
|
emergencyContactConsent | boolean |
Gibt an, ob der Notfallkontakt seine Zustimmung erteilt hat, um seine Details zu speichern. |
|
|
Name des Notfallkontakts
|
emergencyContactName | string |
Der Name des Notfallkontakts der Person |
|
|
Notfallkontaktbeziehungs-ID
|
emergencyRelationshipId | integer |
Die Beziehung zwischen dem Notfallkontakt und der Person |
|
|
Notruftelefon
|
emergencyContactTelephone | string |
Die Telefonnummer des Notfallkontakts der Person |
|
|
Notfalladresse
|
emergencyAddress | string |
Die Notfalladresse der Personen |
|
|
Nächster Kin-Name
|
nextOfKinName | string |
Der Name der nächsten Verwandtschaft der Person |
|
|
Next Of Kin Relationship ID
|
nextOfKinRelationshipId | integer |
Die Beziehung zwischen der nächsten beziehung und der Person |
|
|
Next Of Kin Telephone
|
nextOfKinTelephone | string |
Die nächste Kin-Telefonnummer der Person |
|
|
Wählcode
|
dialingCode | string |
Internationale Wählnummer für die Telefonnummer der Person |
|
|
Arbeitserweiterung
|
workExtension | string |
Die Durchwahlnummer der Person |
|
|
Telefon geschäftlich
|
telephone | string |
Die geschäftliche Telefonnummer der Person |
|
|
Personal Mobile
|
personalMobile | string |
Die persönliche Mobiltelefonnummer der Person |
|
|
Status-ID
|
statusId | integer |
Der StaffCircle-Kontostatus der Person |
|
|
Beschäftigungstyp-ID
|
employmentTypeId | integer |
Der Beschäftigungstyp der Person |
|
|
Vertragstyp-ID
|
contractTypeId | integer |
Vertrag der Person |
|
|
Vertragsablauf
|
contractExpiry | date |
Das Datum, an dem der Arbeitsvertrag der Personen abläuft |
|
|
Beschäftigungsstatus
|
employmentStatusId | integer |
Der Beschäftigungsstatus der Person |
|
|
Sekundärer Beschäftigungsstatus
|
secondaryEmploymentStatusId | integer |
Der verknüpfte sekundäre Beschäftigungsstatus |
|
|
Arbeitsnotizen
|
employmentNotes | string |
Arbeitsnotizen zur Person |
|
|
Medizinische Hinweise
|
medicalNotes | string |
Alle wichtigen medizinischen Notizen, die der Person zugeordnet sind |
|
|
Ist personenbezogene Daten aktiviert
|
isPersonalDataEnabled | boolean |
Gibt an, ob personenbezogene Daten aktiviert sind oder nicht. |
|
|
Ist Kontaktdaten aktiviert
|
isContactDataEnabled | boolean |
Gibt an, ob Kontaktdaten aktiviert sind oder nicht. |
|
|
Zeitzone
|
timeZone | string |
Die Zeitzone, in der sich die Person befindet |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Personen-ID
|
id | integer |
Der Bezeichner der Person |
Erstellen eines neuen Artikels
Erstellt einen neuen Artikel, der über mehrere Kommunikationskanäle an StaffCircle-Benutzer verteilt werden kann
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Title
|
title | True | string |
Titel des Artikels. Maximale Länge 250 Zeichen |
|
Priority
|
priority | True | string |
Was ist die Priorität des Artikels |
|
Artikelart
|
articleType | True | string |
Der Typ des zu erstellenden Artikels |
|
HTML-Inhalt
|
htmlContent | True | string |
Der Haupt-HTML-Inhalt für den Artikel. |
|
Artikelbild-URL
|
mainImageUrl | string |
Die URL zu einem Bild, das als Hauptbild der Artikel im Feed verwendet wird. |
|
|
Zusammenfassung
|
summary | string |
Eine Zusammenfassung des Artikels. Wird standardmäßig auf die ersten 500 Zeichen html-Inhalte festgelegt, falls nicht angegeben. |
|
|
Tag
|
tag | True | string |
Das Tag, das dem Artikel zugeordnet ist. Max. Zeichen 250 |
|
Kanal-ID
|
channelId | integer |
Auf welchen Kanal wird der Artikel veröffentlicht. Wenn sie leer gelassen wird, wird sie auf den Standardfeed festgelegt. |
|
|
Pushbenachrichtigungen senden
|
push | boolean |
Gibt an, ob Benutzer über den Artikel über Pushbenachrichtigungen benachrichtigt werden sollen. |
|
|
SMS-Benachrichtigungen senden
|
sms | boolean |
Gibt an, ob Benutzer über den Artikel über SMS-Benachrichtigungen benachrichtigt werden sollen |
|
|
Senden von E-Mail-Benachrichtigungen
|
boolean |
Gibt an, ob Benutzer über den Artikel per E-Mail-Benachrichtigung benachrichtigt werden sollen. |
||
|
Senden von App-Benachrichtigungen
|
inApp | boolean |
Gibt an, ob Benutzer über den Artikel über App-Benachrichtigungen benachrichtigt werden sollen. |
|
|
Teams-Benachrichtigungen senden
|
teams | boolean |
Gibt an, ob Benutzer über den Artikel über Microsoft Teams-Benachrichtigungen benachrichtigt werden sollen. |
|
|
Gefällt mir zulassen
|
allowLikes | boolean |
Kann Benutzern der Artikel gefällt. Standard true |
|
|
Kommentare zulassen
|
allowComments | boolean |
Kann Benutzer den Artikel kommentieren. Die Standardeinstellung ist „true“. |
|
|
Bilder in Kommentaren zulassen
|
allowImagesInComments | boolean |
Gibt an, ob Bilder in Kommentaren zulässig sind |
|
|
Ab Datum anheften
|
pinFromDate | date-time |
Sollte der Artikel angeheftet werden. Wenn ja, geben Sie ein Datum an. Erforderlich, wenn Pin-Dauer Stunden angegeben |
|
|
Stunden für die Pindauer
|
pinDurationHours | integer |
Wie viele Stunden nach dem Anheften von Datum sollte der Artikel angeheftet bleiben. Erforderlich, wenn pin from Date angegeben wird. |
|
|
Geplante Uhrzeit der Publikation
|
scheduledDateTime | string |
Sollte dieser Artikel in Zukunft für die Veröffentlichung geplant sein. |
|
|
Sofort veröffentlichen
|
publishImmediately | boolean |
Sollte dieser Artikel sofort veröffentlicht werden |
|
|
Veröffentlichen der Benutzer-ID
|
publishAsUserId | integer |
Wenn der Benutzer nicht den API-Aufruf ausführt, für den dieser Benutzer im Namen des Benutzers erfolgen soll. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Der Bezeichner für den Artikel, der erstellt wurde |
Erstellen eines neuen Ziels
Erstellt ein neues Ziel
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Befähigung
|
categoryId | True | integer |
Die verknüpfte Zielkompetenz |
|
Title
|
title | True | string |
Der Name des neuen Ziels. |
|
Description
|
description | True | string |
Die Beschreibung des neuen Ziels. |
|
Startdatum
|
startDate | True | date-time |
Ab dem Zeitpunkt, an dem das Ziel gemessen wird |
|
Enddatum
|
endDate | True | date-time |
Die Frist für das Ziel |
|
Werttyp
|
valueType | True | string |
Definiert, wie das Ziel gemessen wird. |
|
Tag
|
tag | string |
Ein Texttag, für die Verwendung in Suchvorgängen und Berichterstellung. |
|
|
Manager-E-Mail
|
managerEmail | string |
Die E-Mail des Verantwortlichen für die Verfolgung des Ziels. Der Standardwert ist automatisch der Vorgesetzte für Personen oder Abteilungen. Erforderlich, wenn die Person oder Abteilung keinen Vorgesetzten hat oder das Ziel ein Unternehmensziel ist. Wird verwendet, wenn die Manager-ID nicht angegeben wurde |
|
|
Manager-ID
|
managerId | integer |
Der Manager, der für die Verfolgung des Ziels verantwortlich ist. Der Standardwert ist automatisch der Vorgesetzte für Personen oder Abteilungen. Erforderlich, wenn die Person oder Abteilung keinen Vorgesetzten hat oder das Ziel ein Unternehmensziel ist. Wird verwendet, wenn manager-E-Mail nicht angegeben wurde |
|
|
Personen-E-Mail
|
personEmail | string |
Die E-Mail-Adresse der Person, für die das Ziel vorgesehen ist. Erforderlich, um ein persönliches Ziel zu schaffen. Wenn keine Abteilung oder Person bereitgestellt wird, wird davon ausgegangen, dass es sich um ein Unternehmensziel handelt. |
|
|
Personen-ID
|
personId | integer |
Die ID der Person, für die das Ziel vorgesehen ist. Erforderlich, um ein persönliches Ziel zu schaffen. Wenn keine Abteilung oder Person bereitgestellt wird, wird davon ausgegangen, dass es sich um ein Unternehmensziel handelt. |
|
|
Abteilungsname
|
departmentName | string |
Der Name der Abteilung, für die das Ziel vorgesehen ist. Erforderlich, um ein Abteilungsziel zu erstellen. Wenn keine Abteilung oder Person bereitgestellt wird, wird davon ausgegangen, dass es sich um ein Unternehmensziel handelt. |
|
|
Abteilungs-ID
|
departmentId | integer |
Die ID der Abteilung, für die das Ziel vorgesehen ist. Erforderlich, um ein Abteilungsziel zu erstellen. Wenn keine Abteilung oder Person bereitgestellt wird, wird davon ausgegangen, dass es sich um ein Unternehmensziel handelt. |
|
|
Unternehmensziel-ID
|
companyObjectiveId | integer |
Optionaler Link zu einem Unternehmensziel, auf das sich das neu erstellte Ziel bezieht |
|
|
Abteilungsziel-ID
|
departmentObjectiveId | integer |
Optionaler Link zu einem Abteilungsziel, auf das sich das neu erstellte Ziel bezieht |
|
|
Startwert
|
startValue | double |
Definiert, wie das Ziel gemessen wird. |
|
|
Ziel
|
target | double |
Der Zielwert, der erreicht werden soll, damit das Ziel erfolgreich abgeschlossen werden kann |
|
|
Hinzufügen des Fortschritts zulassen
|
allowAddProgress | boolean |
Wenn "true" es einer Person ermöglicht, den Fortschritt selbst hinzuzufügen, andernfalls kann nur der angegebene Manager das Ziel aktualisieren. Standardwert: false. |
|
|
Wiederholen des Typs
|
recurType | string |
Wenn dies angegeben ist, wird das Ziel wiederholt. Definiert die Zeiteinheit für Die Wiederholung. |
|
|
Wiederholungsintervall
|
recurInterval | integer |
Wie viele Tage/Wochen/Monate/Jahre werden das Ziel wieder auftreten. Erforderlich, wenn objektive Rekursionen. |
|
|
Kumulativer Fortschritt
|
cumulativeProgress | boolean |
Gibt an, ob beim Hinzufügen des Fortschritts des StaffCircle-Front-End-Fortschritts als inkrementeller Wert hinzugefügt wird. |
|
|
Pushbenachrichtigung senden
|
push | boolean |
Sendet Pushbenachrichtigungen. |
|
|
SMS-Benachrichtigung senden
|
sms | boolean |
SMS-Benachrichtigungen senden |
|
|
E-Mail-Benachrichtigung senden
|
boolean |
Sendet E-Mail-Updates |
||
|
Teams-Benachrichtigung senden
|
teams | boolean |
Sendet Updates über Microsoft Teams, wenn die Teams-Integration aktiviert ist |
|
|
In App-Benachrichtigung senden
|
inApp | boolean |
Sendet InApp-Benachrichtigungen |
|
|
"Gefällt mir" zulässt
|
allowLikes | boolean |
Zulassen, dass Benutzer Kommentare zum Ziel mögen |
|
|
Kommentare zulassen
|
allowComments | boolean |
Kommentare zum Ziel zulassen |
|
|
Bilder in Kommentaren zulassen
|
allowImagesInComments | boolean |
Alle Bilder, die an Kommentare angefügt werden sollen. |
|
|
Dokumente zulassen
|
allowDocuments | boolean |
Zulassen, dass Dokumente an Kommentare angefügt werden |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ziel-ID
|
id | integer |
Der Zielbezeichner |
Erstellen eines neuen Ziels nach Vorlage
Erstellt ein neues Ziel mithilfe einer Zielvorlage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Zielvorlage
|
objectiveTemplateId | True | integer |
Erstellt ein neues Ziel aus einer Zielvorlage. |
|
Startdatum
|
startDate | True | date-time |
Ab dem Zeitpunkt, an dem das Ziel gemessen wird |
|
Enddatum
|
endDate | True | date-time |
Die Frist für das Ziel |
|
Personen-E-Mail
|
personEmail | string |
Die E-Mail-Adresse der Person, für die das Ziel vorgesehen ist. Erforderlich, um ein persönliches Ziel zu schaffen. Wenn keine Abteilung oder Person bereitgestellt wird, wird davon ausgegangen, dass es sich um ein Unternehmensziel handelt. |
|
|
Personen-ID
|
personId | integer |
Die ID der Person, für die das Ziel vorgesehen ist. Erforderlich, um ein persönliches Ziel zu schaffen. Wenn keine Abteilung oder Person bereitgestellt wird, wird davon ausgegangen, dass es sich um ein Unternehmensziel handelt. |
|
|
Abteilungsname
|
departmentName | string |
Der Name der Abteilung, für die das Ziel vorgesehen ist. Erforderlich, um ein Abteilungsziel zu erstellen. Wenn keine Abteilung oder Person bereitgestellt wird, wird davon ausgegangen, dass es sich um ein Unternehmensziel handelt. |
|
|
Abteilungs-ID
|
departmentId | integer |
Die ID der Abteilung, für die das Ziel vorgesehen ist. Erforderlich, um ein Abteilungsziel zu erstellen. Wenn keine Abteilung oder Person bereitgestellt wird, wird davon ausgegangen, dass es sich um ein Unternehmensziel handelt. |
|
|
Manager-E-Mail
|
managerEmail | string |
Die E-Mail des Verantwortlichen für die Verfolgung des Ziels. Der Standardwert ist automatisch der Vorgesetzte für Personen oder Abteilungen. Erforderlich, wenn die Person oder Abteilung keinen Vorgesetzten hat oder das Ziel ein Unternehmensziel ist. Wird verwendet, wenn die Manager-ID nicht angegeben wurde |
|
|
Title
|
title | string |
Überschreibt den Namen des neuen Ziels. |
|
|
Description
|
description | string |
Überschreibt die Beschreibung des neuen Ziels. |
|
|
Manager-ID
|
managerId | integer |
Der Manager, der für die Verfolgung des Ziels verantwortlich ist. Der Standardwert ist automatisch der Vorgesetzte für Personen oder Abteilungen. Erforderlich, wenn die Person oder Abteilung keinen Vorgesetzten hat oder das Ziel ein Unternehmensziel ist. Wird verwendet, wenn manager-E-Mail nicht angegeben wurde |
|
|
Unternehmensziel-ID
|
companyObjectiveId | integer |
Optionaler Link zu einem Unternehmensziel, auf das sich das neu erstellte Ziel bezieht |
|
|
Abteilungsziel-ID
|
departmentObjectiveId | integer |
Optionaler Link zu einem Abteilungsziel, auf das sich das neu erstellte Ziel bezieht |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ziel-ID
|
id | integer |
Der Bezeichner des erstellten Ziels |
Nach Zielen suchen
Nach Zielen suchen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Suchtitel
|
SearchTitle | string |
Lose Zeichenfolgenüberstimmung auf Der Grundlage des Titels |
|
|
Personen-E-Mail
|
PersonEmail | string |
Die E-Mail der Person, der das Ziel zugewiesen ist |
|
|
Tag
|
Tag | string |
Das Tag, das dem Ziel zugeordnet ist |
|
|
Geschlossen
|
Closed | string |
Wenn das Ziel geschlossen ist. True, wenn andernfalls "false" geschlossen |
|
|
Zieltyp
|
ObjectiveType | string |
Art des Ziels |
|
|
Von
|
From | date-time |
Das Ziel ist ab dieser Zeit aktiv |
|
|
Bis
|
To | date-time |
Das Ziel ist ab dieser Zeit aktiv |
|
|
Aktiv bei
|
ActiveAt | date-time |
Das Ziel ist zu diesem Zeitpunkt aktiv |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
Ziel-ID
|
results.id | integer |
Der Zielbezeichner |
|
Title
|
results.title | string |
Titel des Ziels |
|
Description
|
results.description | string |
Die Beschreibung des Ziels |
|
Tag
|
results.tag | string |
Das Tag, das dem Ziel zugeordnet ist |
|
Zieltyp
|
results.objectiveType | string |
Art des Ziels |
|
Geschlossen
|
results.closed | boolean |
Ob das Ziel geschlossen ist |
|
Geschlossener Grund
|
results.closedReason | string |
Der Grund, warum das Ziel geschlossen wurde |
|
Personen-ID
|
results.person.id | integer |
Der Bezeichner der Person, für die das Ziel vorgesehen ist |
|
Vorname der Person
|
results.person.firstName | string |
Der Vorname der Person, für die das Ziel vorgesehen ist |
|
Familienname der Person
|
results.person.secondName | string |
Der Familienname der Person des Ziels ist für |
|
Manager-ID
|
results.manager.id | integer |
Der Bezeichner des Vorgesetzten |
|
Vorgesetzter Vorname
|
results.manager.firstName | string |
Vorname des Vorgesetzten |
|
Familienname des Managers
|
results.manager.secondName | string |
Familienname des Vorgesetzten |
|
Erstellt von Personen-ID
|
results.createdBy.id | integer |
Der Bezeichner der Person, die das Ziel erstellt hat |
|
Erstellt von Vornamen der Person
|
results.createdBy.firstName | string |
Der Vorname der Person, die das Ziel erstellt hat |
|
Erstellt von Personenfamilienname
|
results.createdBy.secondName | string |
Der Familienname der Person, die das Ziel geschaffen hat |
|
Abteilungs-ID
|
results.department.id | integer |
Der Abteilungsbezeichner, der mit dem Ziel verknüpft ist |
|
Abteilungsname
|
results.department.name | string |
Der Name der Abteilung, die mit dem Ziel verknüpft ist |
|
Abteilungsziel-ID
|
results.departmentObjective.id | integer |
der Bezeichner des Abteilungsziels |
|
Titel des Abteilungsziels
|
results.departmentObjective.title | string |
Zieltitel der Abteilung |
|
Beschreibung der Abteilungsziel
|
results.departmentObjective.description | string |
Die Zielbeschreibung der Abteilung |
|
Unternehmensziel-ID
|
results.companyObjective.id | integer |
Die Unternehmensziel-ID |
|
Titel des Unternehmensziels
|
results.companyObjective.title | string |
Der Titel des Unternehmensziels |
|
Unternehmenszielbeschreibung
|
results.companyObjective.description | string |
Die Unternehmenszielbeschreibung |
|
Aktueller Fortschritt
|
results.currentProgress | double |
Aktuelle Fortschritte im Ziel |
|
Startdatum
|
results.startDate | string |
Ab dem Zeitpunkt, an dem das Ziel gemessen wird |
|
Enddatum
|
results.endDate | string |
Die Frist für das Ziel |
Person per E-Mail abrufen
Versucht, einen Personendatensatz per E-Mail zu finden
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
E-Mail durchsuchen
|
SearchEmail | True | string |
Nach E-Mail suchen |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
ID
|
results.id | integer |
Die ID der Person |
|
Vorname
|
results.firstName | string |
Vorname der Person |
|
Surname
|
results.secondName | string |
Der Nachname der Person |
|
Bekannt als
|
results.knownAs | string |
Wie lautet der Name der Person, die als "Gefällt mir" bezeichnet wird |
|
Email
|
results.email | string |
Die E-Mail-Adresse der Person |
|
Wählcode
|
results.dialingCode | string |
Die Wählfunktion für die Telefonnummer der Person |
|
Handynummer
|
results.mobile | string |
Die Mobiltelefonnummer der Person |
|
Hauptwebsite-ID
|
results.mainSite.id | integer |
Die ID der Hauptwebsite, der die Person zugeordnet ist |
|
Hauptwebsitename
|
results.mainSite.name | string |
Der Name, der der Hauptwebsite zugewiesen wird |
|
Beschreibung
|
results.mainSite.description | string |
Beschreibung |
|
Leiter
|
results.mainSite.manager | string |
Leiter |
|
Manager-ID
|
results.manager.id | integer |
Die Vermittler-ID |
|
Vorgesetzter Vorname
|
results.manager.firstName | string |
Vorname der Vorgesetzten |
|
Vorgesetzter zweiter Name
|
results.manager.secondName | string |
Zweiter Name der Vorgesetzten |
|
Active
|
results.active | boolean |
gibt an, ob die Person derzeit aktiv ist oder nicht |
|
Abteilungs-ID
|
results.department.id | integer |
Die ID der Abteilung, die der Person zugeordnet ist |
|
Abteilungsname
|
results.department.name | string |
Der Name, der der Abteilung zugewiesen wird |
|
Tag
|
results.tag | string |
Das Tag, das die Person zurückgibt |
|
Rollen-ID
|
results.role.id | integer |
Die Rollen-ID |
|
Rollenname
|
results.role.name | string |
Rollenname |
|
Profilbild
|
results.avatarURL | string |
Die URL zum Profilbild der Person |
|
Status-ID
|
results.status.id | integer |
Die Datensatzstatus-ID |
|
Statusname
|
results.status.name | string |
Der Datensatzstatusname |
|
Personenstatus-ID
|
results.personStatus.id | integer |
Die Status-ID der Person |
|
Name des Personenstatus
|
results.personStatus.name | string |
Der Name des Personenstatus |
|
Startdatum
|
results.startDate | string |
Als die Person zum ersten Mal an der Organisation mit der Arbeit begonnen hat |
Auslöser
| Wenn ein neuer Artikel veröffentlicht wird |
Auslösen, wenn ein neuer Artikel veröffentlicht wird |
| Wenn ein neues Ziel hinzugefügt wird |
Trigger, wenn ein neues Ziel hinzugefügt wird |
| Wenn ein Ziel aktualisiert wird |
Trigger, wenn ein Ziel aktualisiert wird |
| Wenn eine neue Abwesenheit hinzugefügt wird |
Trigger, wenn eine neue Abwesenheit hinzugefügt wird |
| Wenn eine neue Aufgabe hinzugefügt wird |
Trigger, wenn eine neue Aufgabe hinzugefügt wird |
| Wenn eine neue Person hinzugefügt wird |
Trigger, wenn eine neue Person hinzugefügt wird |
| Wenn eine neue Überprüfung hinzugefügt wird |
Trigger, wenn eine neue Überprüfung hinzugefügt wird |
Wenn ein neuer Artikel veröffentlicht wird
Auslösen, wenn ein neuer Artikel veröffentlicht wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
name
|
name | string |
name |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Artikel-URL
|
subjectFrontEndUrl | string |
Die URL zum Artikel |
|
ID
|
data.Id | integer |
Der Bezeichner für den Artikel |
|
Title
|
data.Title | string |
Der Titel des Artikels |
|
Zusammenfassung
|
data.Summary | string |
Die Zusammenfassung des Artikels |
|
Tag
|
data.Tag | string |
Das Tag, das dem Artikel zugeordnet ist |
|
Prioritätsname
|
data.PriorityName | string |
Die Priorität des Artikels |
|
Erstellt am
|
data.CreatedAt | date-time |
Das Datum, an dem der Artikel erstellt wurde |
|
Jeder
|
data.AudienceDto.Everyone | boolean |
Gibt an, ob der Artikel für jeden veröffentlicht wird. |
|
Personen
|
data.AudienceDto.Persons | array of object | |
|
Person-Tag
|
data.AudienceDto.Persons.Tag | string |
Zielperson-Tag |
|
Id
|
data.AudienceDto.Persons.Id | integer |
Tag-ID |
|
Sites
|
data.AudienceDto.Sites | array of object | |
|
Websitetag
|
data.AudienceDto.Sites.Tag | string |
Zielwebsite-Tag |
|
Id
|
data.AudienceDto.Sites.Id | integer |
Tag-ID |
|
Departments
|
data.AudienceDto.Departments | array of object | |
|
Abteilungstag
|
data.AudienceDto.Departments.Tag | string |
Zielabteilungstag |
|
Id
|
data.AudienceDto.Departments.Id | integer |
Tag-ID |
|
Erstellt anhand der ID
|
data.CreatedByPerson.PersonId | integer |
Der Bezeichner für die Person, die den Artikel erstellt hat |
|
Erstellt mit Vornamen
|
data.CreatedByPerson.FirstName | string |
Der Vorname der Person, die den Artikel erstellt hat |
|
Erstellt mit Familienname
|
data.CreatedByPerson.FamilyName | string |
Der Familienname der Person, die den Artikel erstellt hat |
|
Erstellt per E-Mail
|
data.CreatedByPerson.Email | string |
Die E-Mail-Adresse der Person, die den Artikel erstellt hat |
|
Geändert am
|
data.ModifiedAt | date-time |
Zeitpunkt der letzten Änderung des Artikels |
|
Geändert durch ID
|
data.ModifiedByPerson.PersonId | integer |
Der Bezeichner der Person, die den Artikel zuletzt geändert hat |
|
Geändert durch Vorname
|
data.ModifiedByPerson.FirstName | string |
Der Vorname der Person, die den Artikel zuletzt geändert hat |
|
Geändert durch Familienname
|
data.ModifiedByPerson.FamilyName | string |
Der Familienname der Person, die den Artikel zuletzt geändert hat |
|
Von E-Mail geändert
|
data.ModifiedByPerson.Email | string |
Die E-Mail-Adresse der Person, die den Artikel zuletzt geändert hat |
|
Veröffentlichungsdatum
|
data.PublishedDate | date-time |
Wann der Artikel veröffentlicht wurde |
|
Artikelinhalt
|
data.ArticleContent | string |
Der HTML-Inhalt des Artikels |
|
Artikelinhaltstext
|
data.ArticleContentText | string |
Inhalt des Nur-Text-Artikels |
|
Hauptbild-ID
|
data.MainImageId | integer |
Die ID für ein Bild, das als Hauptbild der Artikel im Feed verwendet wird. |
Wenn ein neues Ziel hinzugefügt wird
Trigger, wenn ein neues Ziel hinzugefügt wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name, der dem Webhook zugewiesen wird |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datensatz-URL
|
subjectFrontEndUrl | string |
Die URL zum Datensatz in StaffCircle |
|
Ziel-ID
|
data.id | integer |
Der Bezeichner des Ziels |
|
Zielvorlage
|
data.templateId | integer |
Erstellt ein neues Ziel aus einer Zielvorlage. |
|
Manager-ID
|
data.manager.PersonId | integer |
Bezeichner des Vorgesetzten der Person |
|
Vorgesetzter Vorname
|
data.manager.FirstName | string |
Vorname des Vorgesetzten der Person |
|
Familienname des Managers
|
data.manager.FamilyName | string |
Der Familienname des Vorgesetzten der Person |
|
Manager-E-Mail
|
data.manager.Email | string |
Die E-Mail-Adresse des Vorgesetzten der Person |
|
Personenbezeichner
|
data.person.PersonId | integer |
Der Mit dem Ziel verknüpfte Bezeichner der Person |
|
Vorname der Person
|
data.person.FirstName | string |
Der Vorname der Person, der mit dem Ziel verknüpft ist |
|
Familienname der Person
|
data.person.FamilyName | string |
Der Familienname der Person, der mit dem Ziel verknüpft ist |
|
Personen-E-Mail
|
data.person.Email | string |
Die E-Mail-Adresse der Person, die mit dem Ziel verknüpft ist |
|
Title
|
data.title | string |
Der Name des neuen Ziels |
|
Description
|
data.description | string |
Die Beschreibung des neuen Ziels |
|
Werttyp
|
data.valueType | string |
Definiert, wie das Ziel gemessen wird. |
|
Tag
|
data.tag | string |
Ein Texttag zur Verwendung in Suchvorgängen und Berichten |
|
Kategorie
|
data.category | string |
Die Zielkategorie-ID |
|
Startdatum
|
data.startDate | date-time |
Ab dem Zeitpunkt, an dem das Ziel gemessen wird |
|
Enddatum
|
data.endDate | string |
Die Frist für das Ziel |
|
Datum des letzten Fortschritts
|
data.lastProgressDate | date-time |
Das Datum, an dem es Fortschritte bei dem Ziel gab |
|
geschlossen
|
data.closed | boolean |
geschlossen |
|
Hinzufügen des Fortschritts zulassen
|
data.allowAddProgress | boolean |
Wenn "true" es einer Person ermöglicht, den Fortschritt selbst hinzuzufügen, andernfalls kann nur der angegebene Vorgesetzte das Ziel aktualisieren. |
|
Pushbenachrichtigung
|
data.notificationSettings.push | boolean |
Sendet Pushbenachrichtigungen. |
|
SMS-Benachrichtigung
|
data.notificationSettings.sms | boolean |
SMS-Benachrichtigungen senden |
|
E-Mail-Benachrichtigung
|
data.notificationSettings.email | boolean |
Sendet E-Mail-Updates |
|
Teams-Benachrichtigung
|
data.notificationSettings.microsoftTeams | boolean |
Sendet Updates über Microsoft Teams, wenn die Teams-Integration aktiviert ist |
|
In App-Benachrichtigung
|
data.notificationSettings.inApp | boolean |
Sendet InApp-Benachrichtigungen |
|
"Gefällt mir" zulässt
|
data.contentSettings.allowLikes | boolean |
Zulassen, dass Benutzer Kommentare zum Ziel mögen |
|
Kommentare zulassen
|
data.contentSettings.allowComments | boolean |
Kommentare zum Ziel zulassen |
|
Bilder in Kommentaren zulassen
|
data.contentSettings.allowImagesInComments | boolean |
Alle Bilder, die an Kommentare angefügt werden sollen. |
|
Dokumente zulassen
|
data.contentSettings.allowDocuments | boolean |
Zulassen, dass Dokumente an Kommentare angefügt werden |
|
Erstellt unter
|
data.createdAt | date-time |
Wenn das Ziel erstellt wurde |
|
Erstellt von Personen-ID
|
data.createdByPerson.PersonId | integer |
Der Bezeichner der Person, die das Ziel erstellt hat |
|
Erstellt von Vornamen der Person
|
data.createdByPerson.FirstName | string |
Der Vorname der Person, die das Ziel erstellt hat |
|
Erstellt von Personenfamilienname
|
data.createdByPerson.FamilyName | string |
Der Familienname der Person, die das Ziel geschaffen hat |
|
Erstellt von Personen-E-Mail
|
data.createdByPerson.Email | string |
Die E-Mail-Adresse der Person, die das Ziel erstellt hat |
|
Aktueller Fortschritt
|
data.currentProgress | double |
Aktuelle Fortschritte im Ziel |
|
Startwert
|
data.startValue | double |
Definiert, wie das Ziel gemessen wird. |
|
Ziel
|
data.targetValue | double |
Der Zielwert, der erreicht werden soll, damit das Ziel erfolgreich abgeschlossen werden kann |
Wenn ein Ziel aktualisiert wird
Trigger, wenn ein Ziel aktualisiert wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name, der dem Webhook zugewiesen wird |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datensatz-URL
|
subjectFrontEndUrl | string |
Die URL zum Datensatz in StaffCircle |
|
ID
|
data.id | integer |
Der Bezeichner des Zielfortschrittsdatensatzes |
|
Ziel-ID
|
data.objectiveId | integer |
Das Ziel, dem dieser Statusdatensatz zugeordnet ist |
|
Wert
|
data.value | double |
Der Gesamtfortschrittswert für das Objekt |
|
Description
|
data.description | string |
Die Beschreibung, die dem Zielstatusdatensatz hinzugefügt wurde |
|
Erstellt am
|
data.createdAt | date-time |
Wann der Statusdatensatz erstellt wurde |
|
Erstellt von Personen-ID
|
data.createdByPerson.PersonId | integer |
Der Bezeichner der Person, die den Fortschrittszieldatensatz erstellt hat |
|
Erstellt mit Vornamen
|
data.createdByPerson.FirstName | string |
Der Vorname der Person, die den Zielfortschrittsdatensatz erstellt hat |
|
Erstellt mit Familienname
|
data.createdByPerson.FamilyName | string |
Der Familienname der Person, die den Zielfortschrittsdatensatz erstellt hat |
|
Erstellt per E-Mail
|
data.createdByPerson.Email | string |
Die E-Mail-Adresse der Person, die den Zielstatusdatensatz erstellt hat |
|
Benachrichtigungen senden
|
data.sendNotifications | boolean |
Gibt an, ob Benachrichtigungen gesendet wurden |
Wenn eine neue Abwesenheit hinzugefügt wird
Trigger, wenn eine neue Abwesenheit hinzugefügt wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name, der dem Webhook zugewiesen wird |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datensatz-URL
|
subjectFrontEndUrl | string |
Die URL des Datensatzes in StaffCircle |
|
ID
|
data.id | integer |
Der Bezeichner der Abwesenheit |
|
Personen-ID
|
data.requestedForPerson.PersonId | integer |
Der Bezeichner der Person, für die die Abwesenheitsanforderung vorgesehen ist |
|
Vorname der Person
|
data.requestedForPerson.FirstName | string |
Der Vorname der Person, für die die Abwesenheitsanforderung gilt |
|
Familienname der Person
|
data.requestedForPerson.FamilyName | string |
Der Familienname der Person, für die die Abwesenheitsanforderung gilt |
|
Personen-E-Mail
|
data.requestedForPerson.Email | string |
Die E-Mail-Adresse der Person, für die die Abwesenheitsanforderung vorgesehen ist |
|
Einheitentyp
|
data.unitType | string |
Der Einheitentyp der Abwesenheitsanforderung (Stunden, Tage) |
|
Anzahl der Stunden
|
data.numberOfHours | double |
Die Anzahl der Stunden, die abgefordert wurden |
|
Teiltag
|
data.partialDay | string |
Gibt an, ob ein Teiltag abgefragt wurde (Morgen, Nachmittag) |
|
Startdatum
|
data.start | date-time |
Wenn die Abwesenheit beginnt |
|
Enddatum
|
data.end | date-time |
Wenn die Abwesenheit zu einem Ende kommt |
|
Typ-ID
|
data.typeId | integer |
Der Bezeichner für den Typ der angeforderten Abwesenheit |
|
Typ
|
data.type | string |
Der Typ der angeforderten Abwesenheit |
|
Untertyp-ID
|
data.subTypeId | integer |
Der Bezeichner für den Untertyp der angeforderten Abwesenheit |
|
Richtlinien-ID
|
data.policyId | integer |
Der Bezeichner der Abwesenheitsrichtlinie, auf der sich der Mitarbeiter befindet |
|
Ursache
|
data.reason | string |
Der Grund für die Abwesenheitsanforderung |
|
Erstellt am
|
data.createdAt | date-time |
Zeitpunkt, an dem die Abwesenheitsanforderung gestellt wurde |
|
Erstellt anhand der ID
|
data.createdByPerson.PersonId | integer |
Der Bezeichner der Person, die die Abwesenheitsanforderung erstellt hat |
|
Erstellt mit Vornamen
|
data.createdByPerson.FirstName | string |
Der Vorname der Person, die die Abwesenheitsanforderung erstellt hat |
|
Erstellt mit Familienname
|
data.createdByPerson.FamilyName | string |
Der Familienname der Person, die die Abwesenheitsanforderung erstellt hat |
|
Erstellt per E-Mail
|
data.createdByPerson.Email | string |
Die E-Mail-Adresse der Person, die die Abwesenheitsanforderung erstellt hat |
|
Genehmigungsstatus
|
data.approvalDetails.status | string |
Der Status der Genehmigung (Ausstehend,Genehmigt,Abgelehnt) |
|
Genehmigt am
|
data.approvalDetails.approvedAt | date-time |
Zeitpunkt der Genehmigung der Abwesenheit |
|
Genehmigungsantwort
|
data.approvalDetails.response | string |
Die antwort, die der genehmigende Benutzer erhält |
|
Genehmigt nach ID
|
data.approvalDetails.approvedByPerson.PersonId | integer |
Der Bezeichner der Person, die die Abwesenheit genehmigt hat |
|
Genehmigt mit Vornamen
|
data.approvalDetails.approvedByPerson.FirstName | string |
Der Vorname der Person, die die Abwesenheit genehmigt hat |
|
Genehmigt nach Familienname
|
data.approvalDetails.approvedByPerson.FamilyName | string |
Der Name der Person, die die Abwesenheit genehmigt hat |
|
Genehmigt per E-Mail
|
data.approvalDetails.approvedByPerson.Email | string |
Die E-Mail-Adresse der Person, die die Abwesenheit genehmigt hat |
|
Manager-ID
|
data.manager.PersonId | integer |
Der Bezeichner des Vorgesetzten, der an der Abwesenheitsanforderung beteiligt ist |
|
Vorgesetzter Vorname
|
data.manager.FirstName | string |
Der Vorname des Vorgesetzten, der an der Abwesenheitsanforderung beteiligt ist |
|
Familienname des Managers
|
data.manager.FamilyName | string |
Der Familienname des Vorgesetzten, der an der Abwesenheitsanforderung beteiligt ist |
|
Manager-E-Mail
|
data.manager.Email | string |
Die E-Mail-Adresse des Vorgesetzten, der an der Abwesenheitsanforderung beteiligt ist |
Wenn eine neue Aufgabe hinzugefügt wird
Trigger, wenn eine neue Aufgabe hinzugefügt wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name, der dem Webhook zugewiesen wird |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datensatz-URL
|
subjectFrontEndUrl | string |
Die URL zum Datensatz in StaffCircle |
|
ID
|
data.id | integer |
Der Bezeichner des Vorgangs |
|
Title
|
data.title | string |
Der Titel des Vorgangs |
|
Description
|
data.description | string |
Die Beschreibung des Vorgangs |
|
Priority
|
data.priority | string |
Die Priorität des Vorgangs |
|
Aufgabengruppen-ID
|
data.groupId | integer |
Der Bezeichner der Aufgabengruppe |
|
Aufgabengruppentitel
|
data.groupTitle | string |
Der Titel der Aufgabengruppe |
|
Ist Adhoc
|
data.isAdhoc | boolean |
Ob dies eine Adhoc-Aufgabe ist |
|
Erstellt von Personen-ID
|
data.createdByPerson.PersonId | integer |
Der Bezeichner der Person, die die Aufgabe erstellt hat |
|
Erstellt mit Vornamen
|
data.createdByPerson.FirstName | string |
Der Vorname der Person, die die Aufgabe erstellt hat |
|
Erstellt mit Familienname
|
data.createdByPerson.FamilyName | string |
Der Familienname der Person, die die Aufgabe erstellt hat |
|
Erstellt per E-Mail
|
data.createdByPerson.Email | string |
Die E-Mail der Person, die die Aufgabe erstellt hat |
|
Personen-ID
|
data.person.PersonId | integer |
Der Bezeichner der Person, für die die Aufgabe vorgesehen ist |
|
Vorname der Person
|
data.person.FirstName | string |
Der Vorname der Person, für die die Aufgabe vorgesehen ist |
|
Familienname der Person
|
data.person.FamilyName | string |
Der Familienname der Person, für die die Aufgabe bestimmt ist |
|
Personen-E-Mail
|
data.person.Email | string |
Die E-Mail der Person, für die die Aufgabe vorgesehen ist |
|
Manager-ID
|
data.manager.PersonId | integer |
Der Bezeichner des Vorgesetzten der Aufgabe |
|
Vorgesetzter Vorname
|
data.manager.FirstName | string |
Der Vorname des Vorgesetzten der Aufgabe |
|
Familienname des Managers
|
data.manager.FamilyName | string |
Der Familienname des Vorgesetzten der Aufgabe |
|
Manager-E-Mail
|
data.manager.Email | string |
Die E-Mail des Vorgesetzten der Aufgabe |
|
Fälligkeitsdatum
|
data.dueDate | date |
Wenn der Vorgang fällig ist |
|
Erstellt am
|
data.createdOn | date-time |
Wann die Aufgabe erstellt wurde |
|
Formular-ID
|
data.form.id | integer |
Der Bezeichner des Formulars, das zum Ausfüllen der Aufgabe verwendet wird |
|
Formulartitel
|
data.form.title | string |
Der Titel des Formulars, das zum Ausfüllen der Aufgabe verwendet wird |
|
Pushbenachrichtigungen
|
data.notificationSettings.push | boolean |
Gibt an, ob In Pushbenachrichtigungen für die Aufgabe gesendet werden |
|
SMS-Benachrichtigungen
|
data.notificationSettings.sms | boolean |
Gibt an, ob in SMS-Benachrichtigungen für die Aufgabe gesendet werden |
|
E-Mail-Benachrichtigungen
|
data.notificationSettings.email | boolean |
Gibt an, ob E-Mail-Benachrichtigungen für die Aufgabe gesendet werden |
|
Microsoft Teams-Benachrichtigungen
|
data.notificationSettings.microsoftTeams | boolean |
Gibt an, ob in Microsoft Teams-Benachrichtigungen für die Aufgabe gesendet werden |
|
In App-Benachrichtigungen
|
data.notificationSettings.inApp | boolean |
Gibt an, ob in App-Benachrichtigungen für die Aufgabe gesendet werden |
|
Gefällt mir zulassen
|
data.contentSettings.allowLikes | boolean |
Gibt an, ob die Aufgabe "Gefällt mir" zulässt. |
|
Kommentare zulassen
|
data.contentSettings.allowComments | boolean |
Gibt an, ob die Aufgabe Kommentare zulässt. |
|
Bilder in Kommentaren zulassen
|
data.contentSettings.allowImagesInComments | boolean |
Gibt an, ob die Aufgabe Bilder in Kommentaren zulässt. |
|
Dokumente zulassen
|
data.contentSettings.allowDocuments | boolean |
Gibt an, ob die Aufgabe Dokumente zulässt. |
Wenn eine neue Person hinzugefügt wird
Trigger, wenn eine neue Person hinzugefügt wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name, der dem Webhook zugewiesen wird |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datensatz-URL
|
subjectFrontEndUrl | string |
Die URL zum Datensatz in StaffCircle |
|
Personen-ID
|
data.id | integer |
Der Bezeichner, der die Person darstellt |
|
Vorname
|
data.givenName | string |
Vorname der Person |
|
Zweitname
|
data.middleName | string |
Vorname der Person |
|
Familienname
|
data.familyName | string |
Der Familienname der Person |
|
Bekannt als
|
data.knownAs | string |
Wie lautet der Name der Person, die als "Gefällt mir" bezeichnet wird |
|
Geburtsdatum
|
data.dateOfBirth | date |
Geburtsdatum der Person |
|
Persönliche Email
|
data.contactDetails.personalEmail | string |
Die persönliche E-Mail-Adresse der Person |
|
Geschäftliche E-Mail
|
data.contactDetails.workEmail | string |
Die geschäftliche E-Mail-Adresse der Person |
|
Mobiles Arbeiten
|
data.contactDetails.workMobile | string |
Die geschäftliche Mobiltelefonnummer der Person |
|
Personal Mobile
|
data.contactDetails.personalMobile | string |
Die persönliche Mobiltelefonnummer der Person |
|
Privattelefon
|
data.contactDetails.homeTelephone | string |
Die Private Telefonnummer der Person |
|
Telefon geschäftlich
|
data.contactDetails.workTelephone | string |
Die geschäftliche Telefonnummer der Person |
|
Telefon geschäftlich
|
data.contactDetails.workExtension | string |
Die Durchwahlnummer der Person |
|
Adresszeile 1
|
data.address.addressLine1 | string |
Die erste Zeile ihrer Privatadresse |
|
Adresszeile 2
|
data.address.addressLine2 | string |
Die erste Zeile ihrer Privatadresse |
|
Stadt
|
data.address.town | string |
Die Residenzstadt der Person |
|
Postleitzahl
|
data.address.postCode | string |
Postcode der Person |
|
Name des Notfallkontakts
|
data.emergencyContact.emergencyContactName | string |
Der Name des Notfallkontakts der Person |
|
Notruftelefon
|
data.emergencyContact.emergencyContactTelephone | string |
Die Telefonnummer des Notfallkontakts der Person |
|
Notfallkontaktbeziehungs-ID
|
data.emergencyContact.emergencyRelationshipId | integer |
Die Beziehung zwischen dem Notfallkontakt und der Person |
|
Zustimmung des Notfallkontakts
|
data.emergencyContact.emergencyContactConsent | boolean |
Gibt an, ob der Notfallkontakt seine Zustimmung erteilt hat, um seine Details zu speichern. |
|
Notfallkontaktadresse
|
data.emergencyContact.emergencyAddress | string |
Die Kontaktadresse der Personen |
|
Medizinische Hinweise
|
data.emergencyContact.emergencyMedicalNotes | string |
Alle wichtigen medizinischen Notizen, die der Person zugeordnet sind |
|
Nächster Kin Name
|
data.nextOfKin.Name | string |
Die der nächsten Kinns der Person |
|
Next of Kin Telephone
|
data.nextOfKin.Telephone | string |
Die nächste Kin-Telefonnummer der Person |
|
Next of Kin Relationship ID
|
data.nextOfKin.RelationshipId | string |
Die Beziehung zwischen der nächsten beziehung und der Person |
|
Arbeitsnotizen
|
data.employeeDetails.employmentNotes | string |
Arbeitsnotizen zur Person |
|
Tag
|
data.employeeDetails.tag | string |
Das Tag, mit dem auf die Person auf der gesamten StaffCircle-Plattform verwiesen werden kann |
|
Startdatum
|
data.employeeDetails.startDate | string |
Wenn die Beschäftigung der Person begonnen hat |
|
ID der Website
|
data.employeeDetails.siteId | integer |
Der Websitebezeichner, zu dem die Person gehört |
|
Gruppen-ID
|
data.employeeDetails.groupId | integer |
Die Gruppe, zu der die Person gehört |
|
Abteilungs-ID
|
data.employeeDetails.departmentId | integer |
Die Abteilung, zu der die Person gehört |
|
Manager-ID
|
data.employeeDetails.manager.PersonId | integer |
Der Bezeichner des Vorgesetzten des Parsons |
|
Vorname des Vorgesetzten
|
data.employeeDetails.manager.FirstName | string |
Der Vorname des Vorgesetzten der Person |
|
Familienname des Vorgesetzten
|
data.employeeDetails.manager.FamilyName | string |
Der Familienname des Vorgesetzten der Person |
|
Manager-E-Mail
|
data.employeeDetails.manager.Email | string |
Die E-Mail-Adresse des Vorgesetzten der Person |
|
Kontostatus
|
data.accountStatus | integer |
Der StaffCircle-Kontostatus der Person |
Wenn eine neue Überprüfung hinzugefügt wird
Trigger, wenn eine neue Überprüfung hinzugefügt wird
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name, der dem Webhook zugewiesen wird |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datensatz-URL
|
subjectFrontEndUrl | string |
Die URL des Datensatzes in StaffCircle |
|
ID
|
data.id | integer |
Der Prüfbezeichner |
|
Vorherige Überprüfungs-ID
|
data.previousReviewId | integer |
Der Bezeichner der vorherigen Überprüfung für diesen Prüfer |
|
Manager-ID
|
data.manager.PersonId | integer |
Der Bezeichner des Managers, der der Überprüfung zugeordnet ist |
|
Vorgesetzter Vorname
|
data.manager.FirstName | string |
Der Vorname des Vorgesetzten, der der Überprüfung zugeordnet ist |
|
Familienname des Managers
|
data.manager.FamilyName | string |
Der Familienname des Vorgesetzten, der der Überprüfung zugeordnet ist |
|
Manager-E-Mail
|
data.manager.Email | string |
Die E-Mail-Adresse des Vorgesetzten, der der Überprüfung zugeordnet ist |
|
internalReviewerPersonIds
|
data.internalReviewerPersonIds | array of integer |
internalReviewerPersonIds |
|
Prüfer-ID
|
data.person.PersonId | integer |
Der Bezeichner des Bearbeiters |
|
Reviewee Vorname
|
data.person.FirstName | string |
Der Vorname des Bearbeiters |
|
Überprüfen des Familiennamens
|
data.person.FamilyName | string |
Der Familienname des Bearbeiters |
|
E-Mail überprüfen
|
data.person.Email | string |
Die E-Mail-Adresse des Prüferes |
|
Title
|
data.title | string |
Der Titel, der der Rezension zugewiesen wurde |
|
Description
|
data.description | string |
Die Beschreibung, die der Rezension gegeben wird |
|
Überprüfungstyp
|
data.reviewType | string |
Der Typ der Überprüfung |
|
Fällig am
|
data.dueOn | date-time |
Wenn die Überprüfung fällig ist |
|
attachedDocumentIds
|
data.attachedDocumentIds | array of integer |
attachedDocumentIds |
|
linkedObjectives
|
data.linkedObjectives | array of integer |
linkedObjectives |
|
Bewertungsvorlagen-ID
|
data.appraisalSummary.personAppraisalTemplateId | integer |
Die Zur Erstellung der Bewertung verwendete Bewertungsvorlage |
|
Aktuelle Bewertung
|
data.scores.currentScore | double |
Die aktuelle Bewertung |
|
Erstellt am
|
data.createdAt | date-time |
Wann die Überprüfung erstellt wurde |
|
Erstellt anhand der ID
|
data.createdByPerson.PersonId | integer |
Der Bezeichner der Person, die die Rezension erstellt hat |
|
Erstellt mit Vornamen
|
data.createdByPerson.FirstName | string |
Der Vorname der Person, die die Rezension erstellt hat |
|
Erstellt mit Familienname
|
data.createdByPerson.FamilyName | string |
Der Familienname der Person, die die Rezension erstellt hat |
|
Erstellt per E-Mail
|
data.createdByPerson.Email | string |
Die E-Mail-Adresse der Person, die die Rezension erstellt hat |
|
Gefällt mir zulassen
|
data.contentSettings.allowLikes | boolean |
Gibt an, ob Likes zulässig sind. |
|
Kommentare zulassen
|
data.contentSettings.allowComments | boolean |
Gibt an, ob Kommentare für die Rezension zulässig sind. |
|
Bilder in Kommentaren zulassen
|
data.contentSettings.allowImagesInComments | boolean |
Gibt an, ob Bilder in Kommentaren zulässig sind |
|
Dokumente zulassen
|
data.contentSettings.allowDocuments | boolean |
Gibt an, ob Dokumente an die Überprüfung angefügt werden können. |
|
Pushbenachrichtigungen
|
data.notificationSettings.push | boolean |
Gibt an, ob Pushbenachrichtigungen gesendet werden sollen |
|
SMS-Benachrichtigungen
|
data.notificationSettings.sms | boolean |
Gibt an, ob SMS-Benachrichtigungen gesendet werden sollen |
|
E-Mail-Benachrichtigung
|
data.notificationSettings.email | boolean |
Gibt an, ob E-Mail-Benachrichtigungen gesendet werden sollen |
|
Microsoft Teams-Benachrichtigungen
|
data.notificationSettings.microsoftTeams | boolean |
Gibt an, ob Microsoft Teams-Benachrichtigungen gesendet werden sollen |
|
In App-Benachrichtigungen
|
data.notificationSettings.inApp | boolean |
Gibt an, ob In App-Benachrichtigungen gesendet werden sollen |