---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Webhook-API für Arbeitsplatz-Connector

# Webhook-API für Arbeitsplatz-Connector {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

Die Webhook Für Arbeitsplatz-Connector API ist eine generische Schnittstelle, die die Speicherung von Daten aus verschiedenen Arten von Arbeitsplatzhardware oder -Sensoren (z. B. Abzeichensysteme oder Belegungssensoren) in Tabellen für Arbeitsplatzservicebereitstellung ermöglicht.
Diese API wird in ausgeführt `sn_wsd_wc `Namespace. Für den Zugriff auf diese API muss das Plugin „Arbeitsplatz-Connectors" (com.sn_wsd_wc) aktiviert sein.

Bevor Sie diese API aufrufen, müssen Sie Datensätze in den Tabellen „Connector-Konfiguration" \[sn_wsd_wc_connector_config\] und „Anbieterkonfiguration \[sn_wsd_wc_provider_config\]" konfigurieren. Informationen zum Konfigurieren dieser Datensätze finden Sie unter [Configure Workplace Connectors](https://www.servicenow.com/docs/access?context=configure-workplace-connectors&version=yokohama&pubname=yokohama-employee-service-management&ft:locale=en-US).

Darüber hinaus müssen Sie einen Erweiterungspunkt einrichten, der die Datenkonvertierung/-Zuordnung von der Hardware-/sensorbasierten Ereignisnutzlast zum Ziel definiert ServiceNowTabelle, z. B. die Tabelle „Mitarbeiteranwesenheitsdaten" \[sn_wsd_wc_employee_attendance_data\].

Weitere Informationen zu Arbeitsplatzverbinder-Webhooks finden Sie unter [Workplace Connectors](https://www.servicenow.com/docs/access?context=workplace-connectors-landing-page&version=yokohama&pubname=yokohama-employee-service-management&ft:locale=en-US).

## Webhook des Arbeitsplatzverbinders -- POST /Workplace_Connector_webhook/event {#ariaid-title2}

Erstellt einen Datensatz in der Tabelle „Connector-Ereignisse" \[sn_wsd_wc_connector_events\] und speichert dann die Hardware-/sensorbasierten Ereignisdaten, die in der Nutzlast des Endpunkts übergeben werden, im Feld „Nutzlast" dieses Datensatzes.
Nachdem der Endpunkt die Nutzlast gespeichert hat, wird das Feld Status im Datensatz „Connector-Ereignisse" auf festgelegt `Neu `, Gibt an, dass die Nutzlast nicht verarbeitet wurde.

Eine geplante Aufgabe sucht die neuen Abzeichendatensätze in der Tabelle „Connector-Ereignisse" und transformiert sie und schreibt sie in die Tabelle „Mitarbeiteranwesenheitsdaten" \[sn_wsd_wc_employee_attendance_data\]. Das Feld Status wird dann auf festgelegt `Verarbeitet `.

Die Zuordnung der Daten zwischen den Nutzlastdaten im Datensatz „Connector-Ereignisse" und dem Datensatz „Mitarbeiteranwesenheitsdaten" wird in einem Erweiterungspunkt definiert. Dieser Erweiterungspunkt wird im Feld „Erweiterungspunktdefinition" in der Tabelle „zugehörige Connector-Konfiguration" \[sn_wsd_wc_connector_config\] identifiziert. Für diesen Endpunkt ist dies der BadgingDataHandler-Erweiterungspunkt.  
Hinweis:  
Datensätze in der Connector-Ereignistabelle in `Verarbeitet `status werden nach zwei Tagen ab dem Erstellungsdatum gelöscht. Datensätze in `Fehler `status werden nach sieben Tagen ab Erstellungsdatum gelöscht. Datensätze in `Neu `status ist nie gelöscht.

### URL-Format

Versionierte URL: /api/sn_wsd_wc/{api_Version}/Workplace_Connector_Webhook/event

Standard-URL: /api/sn_wsd_wc/Workplace_Connector_Webhook/event  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#work_conn_web-POST-event__entry__2}{#work_conn_web-POST-event__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfad-Parameter]

{#work_conn_web-POST-event__entry__6}

| Name | Beschreibung |
|-|-|
| ni.nolog.id | Erforderlich. SYS_ID des Anbieterkonfigurationsdatensatzes, der der Hardware zugeordnet ist, die die Ereignisinformationen generiert hat. Datentyp: Zeichenfolge Tabelle: Anbieterkonfiguration \[sn_wsd_wc_provider_config\] |
| Token_Name | Name des Sicherheitstoken, z. B. ein Anwendername oder ein anderer Wert, der das Sicherheitstoken identifiziert. Wird zum Authentifizieren der Anforderung verwendet. Datentyp: Zeichenfolge Tabelle: Anbieterkonfiguration \[sn_wsd_wc_provider_config\] |
| Token_Wert | Wert, der dem Sicherheitstoken zugeordnet ist, z. B. ein Passwort. Wird zum Authentifizieren der Anforderung verwendet. Datentyp: Zeichenfolge Tabelle: Anbieterkonfiguration \[sn_wsd_wc_provider_config\] |
[Tabelle : 2. Abfrageparameter]

{#work_conn_web-POST-event__entry__14}

| Name | Beschreibung |
|-|-|
| \<payload\> | Name-Wert-Paare der Hardware-/sensorbasierten Ereignisdaten. Die Namen müssen den Namen entsprechen, die im Erweiterungspunkt „BadgingDataHandler" identifiziert wurden. Zum Beispiel: { "Time zone": "(UTC-08:00) Pacific Time (US & Canada)", "Event": "Access granted", "Door": "L_SJC005_B1.101_ELEVATOR 2 INT", "Side": "Reader - In", "Cardholder": "ninat.salem", "First name": "Nina T", "Last name": "Salem", "Credential": " ninat.salem's credential", "Employee ID (Cardholder)": "10097", "Event timestamp": "11/07/2022 00:56:57" } Sie können Daten mehrerer Ereignisse innerhalb eines einzelnen Endpunktaufrufs übergeben. Übergeben Sie die Daten jedes Ereignisses in einem separaten Objekt. Die Daten jedes Ereignisses werden in einem separaten Datensatz mit Mitarbeiteranwesenheitsdaten gespeichert. Hinweis: Stellen Sie sicher, dass der angegebene Zeitstempel der ISO 8601-Formatierung entspricht, um Probleme bei der Datumsanalyse zu vermeiden. Datentyp: JSON-Objekt |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#work_conn_web-POST-event__entry__18}{#work_conn_web-POST-event__accept-JSON-only-entry-RESTAPI}{#work_conn_web-POST-event__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 4. Anforderungskopfzeilen.]

{#work_conn_web-POST-event__entry__24}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#work_conn_web-POST-event__table_fqw_2fg_xyb__entry__2}{#work_conn_web-POST-event__entry-200-status-code}{#work_conn_web-POST-event__entry-400-status-code}{#work_conn_web-POST-event__entry-401-status-code}{#work_conn_web-POST-event__entry-404-status-code}{#work_conn_web-POST-event__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

{#work_conn_web-POST-event__table_fqw_2fg_xyb}

### Antworttext-Parameter

{#work_conn_web-POST-event__entry__40}

| Name | Beschreibung |
|-|-|
| Fehler | Beschreibung aller Fehler, die während der Verarbeitung der Daten aufgetreten sind. Datentyp: Objekt "error": { "detail": "String", "message": "String" "status": "String" } |
| error.detail | Informationen, die Details zum Fehler enthalten. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung. Datentyp: Zeichenfolge |
| Status | Status der Endpunktverarbeitung. Mögliche Werte: * Fehler: Endpunkt fehlgeschlagen. Weitere Informationen finden Sie unter errorObjekt für zusätzliche Details. * Erfolg: Endpunkt erfolgreich abgeschlossen. Datensatz wurde hinzugefügt. {#work_conn_web-POST-event__ul_lkc_q2g_xyb} Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um der Tabelle „Connector-Ereignisse" mehrere Kartenleserereignisse hinzuzufügen. Vor der Verarbeitung der Anforderung wird die Anforderung authentifiziert.

    curl http://instance.servicenow.com/api/sn_wsd_wc/v1/workplace_connector_webhook/event?token_name=token&ni.nolog.id=8e666cb0a3053110bc6e146546fcdad1&token_value=babugosha  \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data --data "{
      \"Time zone\": \"(UTC+02:00) Jerusalem\",
      \"Event\": \"Access granted\",
      \"Door\": \"L_TLV001_A3.07_KITCHEN AREA INT\",
      \"Side\": \"Reader - In\",
      \"Cardholder\": \" ninat.alem\",
      \"First name\": \" Nina T\",
      \"Last name\": \" Salem\",
      \"Credential\": \" ninat.salem's credential\",
      \"Employee ID (Cardholder)\": 10097,
      \"Event timestamp\": \"11/07/2022 10:57:24\"
    }
    {
      \"Time zone\": \"(UTC+02:00) Jerusalem\",
      \"Event\": \"Access granted\",
      \"Door\": \"L_TLV003_A4.07_FRONT ENT\",
      \"Side\": \"Reader - In\",
      \"Cardholder\": \" joe.blue\",
      \"First name\": \" Joe\",
      \"Last name\": \" Blue\",
      \"Credential\": \" joe.blue's credential\",
      \"Employee ID (Cardholder)\": 24098,
      \"Event timestamp\": \"11/07/2022 10:59:33\"
    }"

Antwort:

    // Successful response
    {
      "staus": "success"
    }

    // Error response
    {
      "error": {
        "message": "Events request is invalid. Events query parms incomplete, some fields are missing",
        "detail": "Missing fields: token_name, token_value"
      }
      "status": "failure"
    }


