Zum Hauptinhalt gehen

HTTP Details

Matt
Aktualisiert

Um ein Ereignis an SIGNL4 zu übermitteln, kann der Webhook über eine HTTP-Anfrage aufgerufen werden.
Alle Details finden Sie in diesem Artikel.

HTTP-Eigenschaften

In der folgenden Tabelle ist die HTTP-Unterstützung des Webhooks aufgeführt.

Feature Description Required
Request methods
  • POST
 yes
Request URL

https://connect.signl4.com/webhook/{Secret}

Example request URL:

https://connect.signl4.com/webhook/g93sdfm2843

 yes
Request parameters Further details about optional query parameters for status mapping can be found here. no
Request Header
(Content-type)

Content types supported by the webhook are

  • application/json
  • application/xml
  • application/x-www-form-urlencoded
  • multipart/form-data
  • text/plain

You can use multipart/form-data to post not only text, but also media attachments such as images or sound. Further details can be found here.

 yes
Response Body

One of the greatest strengths of the webhook is its flexibility.
This means that there is no fixed scheme for the response body to be transmitted.
The webhook can parse anything that gets sent to it.

See "Payload schema" for further details.

 no

Response Code

(201)

The transmitted event was received and processed. The response body contains an event ID that can be used to query further details via the SIGNL4 REST API.

Example response body:

{

    "eventId": "2517274649921256161_619fe071-2c15-4258-b939-8a3abccb233e"

}
  

Response Code

(400)

The submitted body is invalid and not in the format specified in the content-type.

Example response body:

{
    "code": 4000,
    "requestId": "ae463741-e8f4-4a07-990f-b28fb317b171",
    "details": "The received event is null or empty.",
    "message": "Error raising event."
}
  

Response Code

(404)

Webhook URL is wrong.

Example response body:

{
    "code": 3004,
    "requestId": "3420299d-9b63-449d-9338-ecc3a815999b",
    "details": "No matching event source found.",
    "message": "Error raising event."
}
  

Response Code

(405)		 The request method used was not POST  

Response Code

(429)

Too many requests were sent and subsequent requests are blocked for a while.

Example response body:

{
  "code": 2004,
  "requestId": "6eee8205-078f-41cd-ace7-bc6e3903a145",
  "details": "Only 5 requests per 15 seconds are allowed. Please try again at 14:14:19 (UTC).",
  "message": "Too Many Requests"
}
  

Musteranfrage und Antwort

Im Folgenden wird ein Beispiel für ein HTTP-Anfrage/Antwort-Paar für ein erfolgreich ausgelöstes Ereignis an den Webhook angezeigt. Die JSON-Nutzdaten im Anfragekörper sind nur ein Beispiel und folgen keinem festen Schema. Sie können jedes JSON senden, das Sie möchten. Der nächste Abschnitt beschreibt, wie das JSON geparst wird.

Request:

POST https://connect.signl4.com/webhook/g93sdfm2843 HTTP/1.1
Host: connect.signl4.com
Connection: keep-alive
Content-Length: 362
Pragma: no-cache
Cache-Control: no-cache
Content-Type: application/json

{
  "Title": "Critical production failure",
  "Message": "Check line machine C immediately",
  "Severity": "High",
  "Business Details": {
      "Impact": "Major",
      "Scope": "Unlimited"
  }
}

Response:

Die obige HTTP-Anfrage liefert im Erfolgsfall die folgende Antwort:

HTTP/1.1 201 Created
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Request-Context: appId=cid-v1:d7865de8-ff22-4cec-8b2d-6e39fb5802f7
X-RateLimit-Limit: 150
X-RateLimit-Remaining: 149
X-RateLimit-Reset: 1675249602
Date: Wed, 01 Feb 202311:06:27 GMT

{
  "eventId": "2517270512120237019_63270570-e8cb-4174-afbb-d09155eb6ec0"
}

Request Drosselung

Der SIGNL4-Webhook wendet eine Request-Drosselung an, um Ereignis-Spamming zu verhindern. Der Drosselungsmechanismus erlaubt es, eine bestimmte Anzahl von HTTP-Anfragen innerhalb eines bestimmten Zeitraums (sog. Anfragezeitraum) zu stellen. Wird diese Anzahl im aktuellen Zeitraum erreicht, werden Sie für weitere Anfragen gesperrt, bis der aktuelle Anfragezeitraum endet. Zusätzlich werden Sie auf einen längeren Anfragezeitraum hochgestuft, was bedeutet, dass Sie bei gleichbleibendem Anfragedurchsatz für eine längere Zeit gesperrt werden.

The following table explains all response headers related to the throttling mechanism and which are returned with each HTTP response.

Header

Meaning

X-RateLimit-Limit

The number of messages you are allowed to send in your current request time period.

X-RateLimit-Remaining

The remaining number of messages you are allowed to send in your current request time period.

X-RateLimit-Reset

Time when the current request time period ends (in epoch time).

Falls im aktuellen Anfragezeitraum keine weiteren Anfragen mehr gestellt werden, beginnt der Webhook mit der Rückgabe von 429 Antworten (siehe Tabelle HTTP-Details oben).

Je nach Ihrem SIGNL4-Plan gibt es unterschiedliche Request time Periods.

Für nicht gewerbliche SIGNL4-Pläne gelten die folgenden Request Limits:

  • 10 events per 15 seconds
  • 240 events per 1 minute
  • 1200 events per 1 hour
  • 4800 events per 1 day

Die folgenden Reques-Limits gelten für alle kommerziellen SIGNL4-Tarife:

  • 150 events per 15 seconds
  • 600 events per 1 minute
  • 36000 events per 1 hour
  • 864000 events per 1 day

 

Verwandte Beiträge

Kommentare

0 Kommentare

Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.