Ausgehende Webhooks

Ausgehende Webhooks übermitteln Ereignisse in SIGNL4 an Anwendungen von Drittanbietern

SIGNL4 kann Ihren Web-Hook aufrufen, wenn bestimmte Ereignisse eintreten (z.B. wenn jemand einen Alarm quittiert hat oder sich zum Dienst anmeldet).

Diese Seite beschreibt das JSON-Format der Benachrichtigungen, die als HTTP POST an Ihren Web-Hook gesendet werden.

Sie können Ihre Web-Hooks hier in der Kontoverwaltung von SIGNL4 registrieren. Bitte beachten Sie, dass Sie den eingehenden Web-Hook Ihres SIGNL4-Teams nicht als ausgehenden Web-Hook für Ereignisbenachrichtigungen registrieren können, um endlose Datenschleifen zu vermeiden.

Jede Benachrichtigung enthält einen eindeutigen Bezeichner (ID). Sie können diesenverwenden, um sicherzustellen, dass Sie Benachrichtigungen nur einmal verarbeiten, falls sie mehrfach von Ihrem Web-Hook empfangen werden. Außerdem enthält jede Benachrichtigung ein oder mehrere Objekte, für die die Benachrichtigung ausgelöst wurde (z.B. ein Benutzerobjekt, wenn ein Benutzer sich eingeloggt hat). Sie können zusätzliche Eigenschaften dieser Objekte über die SIGNL4-API abfragen, indem Sie deren id-Wert verwenden.

Wir empfehlen dringend, den Parameter X-S4-ExternalID zu verwenden, um ausgehende Webhook-Aufrufe mit dem ursprünglichen eingehenden Webhook-Aufruf abzugleichen, den Sie verwendet haben, um ein Ereignis an SIGNL4 zu übermitteln. Hier finden Sie ein Video darüber, wie dieser Parameter für die 2-Wege-Synchronisierung verwendet werden kann.

Neues Signl erstellt
Signl Bestätigt
Signl Aufgelöst
Zeichen Eskaliert
Signl Kommentiert
Dienstzeit Begonnen
Dienstperiode beendet
Jemand hat eingesteckt
Jemand hat sich verplappert

Neues Signl erstellt

Der EventType-Wert von 200 bedeutet, dass ein neues Signl für Ihr Team erstellt wurde.

Einige Details werden innerhalb des Alert-Objekts übergeben.
Sie können die eventId Attribut, um diese Benachrichtigung mit einem Signl zu verknüpfen, das Sie zuvor über den Inbound-Webhook Ihres Teams ausgelöst haben (der Inbound-Webhook gibt für jedes übermittelte Ereignis eine eventId zurück).
Wenn Sie die Korrelation über eine ID in Ihrem externen System bevorzugen, können Sie diesen Wert in einem Parameter namens X-S4-Service und Sie erhalten sie in der Eigenschaft externalEventId des Alarm-Objekts zurück.

{
  "eventType": 200,
  "eventRaisedUtc": "2017-09-01T08:11:37.4815663Z",
  "subscription": {
    "id": "0acf8014-22f2-4503-88d7-f7d05b46744f"
  },
  "alert": {
    "statusCode": 1,
    "eventId": "2518783235949759942_fbc7b4a4-badd-47b8-9e1d-702fb6a1a0b2",
    "externalEventId":"Content you passed in the X-S4-ExternalID parameter"
    "id": "2518981069381242800_2ab1b5e0-f1b7-4c3e-9adf-6c157eeb4685"
  },
  "id": "dd209a2d-e037-41ee-b37d-f605cc0a39fb"
}
Signl Bestätigt

Der EventType-Wert von 201 bedeutet, dass sich der Status eines Signals in Ihrem Team geändert hat.
Wenn der statusCode-Wert des Alarm Objekt gleich 2 ist, bedeutet dies, dass der Jemand (siehe Benutzer Objekt) hat das Signl bestätigt.

Einige weitere Details werden innerhalb des Alarmobjekts übergeben.
Sie können die eventId Attribut, um diese Benachrichtigung mit einem Signl zu korrelieren, das Sie zuvor über den Inbound-Webhook Ihres Teams ausgelöst haben (der Inbound-Webhook liefert für jedes übermittelte Ereignis eine eventId).
Wenn Sie die Korrelation über eine ID in Ihrem externen System bevorzugen, können Sie diesen Wert in einem Parameter namens X-S4-Service und Sie erhalten sie in der Eigenschaft externalEventId des Alarm-Objekts zurück.

{
  "eventType": 201,
  "eventRaisedUtc": "2017-09-01T08:11:37.4815663Z",
  "subscription": {
    "id": "0acf8014-22f2-4503-88d7-f7d05b46744f"
  },
  "user": {
    "username": "Rene",
    "mailaddress": "[email protected]",
    "id": "f0bd5063-9588-51cf-b3d9-94e5647dedc5"
  },
  "alert": {
    "statusCode": 2,
    "eventId": "2518783235949759942_fbc7b4a4-badd-47b8-9e1d-702fb6a1a0b2",
    "externalEventId":"Content you passed in the X-S4-ExternalID parameter",
    "acknowledgedUserIds": [ "f0bd5063-9588-51cf-b3d9-94e5647dedc5" ],
    "id": "2518981069381242800_2ab1b5e0-f1b7-4c3e-9adf-6c157eeb4685"
  },
  "id": "dd209a2d-e037-41ee-b37d-f605cc0a39fb"
}
Signl Aufgelöst

Der EventType-Wert von 201 bedeutet, dass sich der Status eines Signals in Ihrem Team geändert hat.
Wenn der statusCode-Wert des Alarm Objekt gleich 4 ist, bedeutet dies, dass das Signal aufgelöst wurde.
Die Benutzer Objekt enthält weitere Informationen über die Person, die das Signl aufgelöst hat.

Einige weitere Details werden innerhalb des Alert-Objekts übergeben.
Sie können die eventId Attribut, um diese Benachrichtigung mit einem Signl zu korrelieren, das Sie zuvor über den Inbound-Webhook Ihres Teams ausgelöst haben (der Inbound-Webhook liefert für jedes übermittelte Ereignis eine eventId).
Wenn Sie die Korrelation über eine ID in Ihrem externen System bevorzugen, können Sie diesen Wert in einem Parameter namens X-S4-Service und Sie erhalten sie in der Eigenschaft externalEventId des Alarm-Objekts zurück.

{
  "eventType": 201,
  "eventRaisedUtc": "2017-09-01T08:11:37.4815663Z",
  "subscription": {
    "id": "0acf8014-22f2-4503-88d7-f7d05b46744f"
  },
  "user": { 
    "username": "Rene",
    "mailaddress": "[email protected]", 
    "id": "f0bd5063-9588-51cf-b3d9-94e5647dedc5" 
  },
  "alert": {
    "statusCode": 4,
    "eventId": "2518783235949759942_fbc7b4a4-badd-47b8-9e1d-702fb6a1a0b2",
    "externalEventId":"Content you passed in the X-S4-ExternalID parameter"
    "acknowledgedUserIds": [ "f0bd5063-9588-51cf-b3d9-94e5647dedc5" ],
    "id": "2518981069381242800_2ab1b5e0-f1b7-4c3e-9adf-6c157eeb4685"
  },
  "id": "dd209a2d-e037-41ee-b37d-f605cc0a39fb"
}
Zeichen Eskaliert

Der EventType-Wert von 202 bedeutet, dass ein Signl nicht rechtzeitig bestätigt wurde und daher an einen Manager eskaliert wurde.

Einige weitere Details werden innerhalb des Alert-Objekts übergeben.
Sie können die eventId Attribut, um diese Benachrichtigung mit einem Signl zu korrelieren, das Sie zuvor über den Inbound-Webhook Ihres Teams ausgelöst haben (der Inbound-Webhook liefert für jedes übermittelte Ereignis eine eventId).
Wenn Sie die Korrelation über eine ID in Ihrem externen System bevorzugen, können Sie diesen Wert in einem Parameter namens X-S4-Service und Sie erhalten sie in der Eigenschaft externalEventId des Alarm-Objekts zurück.

{
    "eventType": 202,
    "eventRaisedUtc": "2020-01-10T12:27:19Z",
    "subscription": {
        "id": "b8fdd850-e2ad-45ff-924d-9c332a063200"
    },
    "team": {
        "id": "0e8979f7-0c6a-472d-8918-ecfd339252f8"
    },
    "alert": {
        "statusCode": 1,
        "eventId": "2518236416806594587_0e67b746-6c88-4ddf-8872-99690b0457d9",
        "externalEventId": "INC091210",
        "acknowledgedUserIds": [],
        "id": "2518236416804564453_12ea0f6f-948c-43d0-9034-f9565d7b6bd2"
    },
    "id": "27283793-47c8-4da2-9767-d37be224338d"
}
Signl Kommentiert

Der eventType-Wert 203 bedeutet, dass jemand aus Ihrem Team ein Signl kommentiert hat.

Die Anmerkung Objekt enthält die Nachricht. Die Benutzer Objekt enthält die ID des Benutzers in Ihrem Team, der die Anmerkung erstellt hat. Sie können die REST-API verwenden, um weitere Daten von diesem Benutzer über die ID abzurufen

Einige weitere Details des Signals werden im Alert-Objekt übergeben.
Sie können die eventId Attribut, um diese Benachrichtigung mit einem Signl zu korrelieren, das Sie zuvor über den Inbound-Webhook Ihres Teams ausgelöst haben (der Inbound-Webhook liefert für jedes übermittelte Ereignis eine eventId).
Wenn Sie die Korrelation über eine ID in Ihrem externen System bevorzugen, können Sie diesen Wert in einem Parameter namens X-S4-Service und Sie erhalten sie in der Eigenschaft externalEventId des Alarm-Objekts zurück.

{
  "eventType": 203,
  "eventRaisedUtc": "2018-04-17T15:00:32Z",
  "subscription": { 
    "id": "1578ebd9-0a27-44ab-bc8e-52cd7d32e81d" 
  },
  "user": { 
    "username": "Rene",
    "mailaddress": "[email protected]", 
    "id": "f0bd5063-9588-51cf-b3d9-94e5647dedc5" 
  },
  "alert": {
    "statusCode": 0,
    "eventId": "2518783235949759942_fbc7b4a4-badd-47b8-9e1d-702fb6a1a0b2",
    "externalEventId":"Content you passed in the X-S4-ExternalID parameter",
    "id": "2518783235958846071_4e2dfab2-4717-42bc-8d37-8682402309c2"
  },
  "annotation": {
    "message": "OK, I'll take care about it.",
    "id": "2518783235661483318_99ebffe0-1b90-40ef-990a-fbd842484761"
  },
  "id": "141c0f88-7831-4d5e-b055-f6e83c269770"
}
Dienstzeit Begonnen

Wenn Sie den SIGNL4 Dienstassistenten aktiviert haben (z.B. in der Kontoverwaltung von SIGNL4 hier), erhält Ihr Webhaken diese Benachrichtigung, wenn Ihr Team den Dienst antritt (angezeigt durch einen eventType-Wert von 300). Das Teamobjekt bezieht sich auf Ihr SIGNL4-Team.

{
  "eventType": 300,
  "eventRaisedUtc": "2017-09-01T09:16:17.3717355Z",
  "team": { "id": "f1801955-4724-44de-902a-f6f02ba9e10f" },
  "id": "f56a6b59-1197-4e7d-8eca-8d21a4b57ec3"
}
Dienstperiode beendet

Wenn Sie den SIGNL4 Dienstassistenten aktiviert haben (z.B. in der Kontoverwaltung von SIGNL4 hier), erhält Ihr Webhaken diese Benachrichtigung, wenn Ihr Team den Dienst beendet hat (angezeigt durch einen eventType-Wert von 301). Das Teamobjekt bezieht sich auf Ihr SIGNL4-Team.

{
  "eventType": 301,
  "eventRaisedUtc": "2017-09-01T09:16:17.3717355Z",
  "team": { "id": "f1801955-4724-44de-902a-f6f02ba9e10f" },
  "id": "f56a6b59-1197-4e7d-8eca-8d21a4b57ec3"
}
Jemand hat eingesteckt

Der EventType-Wert 302 bedeutet, dass jemand in Ihrem Team einen Punch-In durchgeführt hat. Das Teamobjekt bezieht sich auf Ihr SIGNL4-Team. Das Benutzerobjekt bezieht sich auf den Benutzer, der sich eingeloggt hat.

{
  "eventType": 302,
  "eventRaisedUtc": "2017-09-01T09:16:17.3717355Z",
  "team": { "id": "f1801955-4724-44de-902a-f6f02ba9e10f" },
  "user": { "id": "e31da15f-7e13-43f1-b4a5-1ce3b470a504" },
  "id": "f56a6b59-1197-4e7d-8eca-8d21a4b57ec3"
}
Jemand hat sich verplappert

Der EventType-Wert 303 bedeutet, dass jemand in Ihrem Team einen Punch-out gemacht hat. Das Teamobjekt bezieht sich auf Ihr SIGNL4-Team. Das Benutzerobjekt bezieht sich auf den Benutzer, der sich ausgestanzt hat.

{
  "eventType": 303,
  "eventRaisedUtc": "2017-09-01T09:16:17.3717355Z",
  "team": { "id": "f1801955-4724-44de-902a-f6f02ba9e10f" },
  "user": { "id": "e31da15f-7e13-43f1-b4a5-1ce3b470a504" },
  "id": "f56a6b59-1197-4e7d-8eca-8d21a4b57ec3"
}