DokumentationProdukteuseNotificationApp-APIApp-API V1
Webhook setzen
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Setzt Zustelladresse und Geheimnis dieser App.
Neue Abonnements dieser App übernehmen den Webhook. Die Adresse muss https:// sein — wir schicken ein Geheimnis dorthin. Das Geheimnis steht in jeder Zustellung im Header X-Webhook-Secret.
PUT https://apps.api.usenotification.artim-industries.com/v1/apps/{id}/webhook
| Methode | PUT |
| Basis | apps.api.usenotification.artim-industries.com/v1 |
| Scope | un.apps.webhook:update |
| Antwort | 200 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer unapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
id | Pfad | string | ja | Die Kennung der App. |
Anfragekörper
| Feld | Typ | Bedeutung |
|---|---|---|
url | string | Die Zustelladresse. Pflicht, https://. |
secret | string | Das Geheimnis, mit dem du die Zustellung prüfst. |
Felder, die der Vertrag nicht nennt, werden verworfen — ein Client kann keine eigenen Felder unterschieben.
{ "url": "https://firma.de/hooks/usenotification", "secret": "s3cret" }
Anfrage
curl -X PUT "https://apps.api.usenotification.artim-industries.com/v1/apps/{id}/webhook" \
-H "Authorization: Bearer unapi_…" \
-H "Content-Type: application/json" \
-d '{ "url": "https://firma.de/hooks/usenotification", "secret": "s3cret" }'
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
url | string | Die gesetzte Adresse. |
hasSecret | boolean | Ob ein Geheimnis hinterlegt ist. |
{ "url": "https://firma.de/hooks/usenotification", "hasSecret": true }
Fehler
| Status | code | Wann |
|---|---|---|
400 | invalid_request | Ein Pflichtfeld fehlt, ein Typ passt nicht, oder ein Verweis zeigt auf etwas, das es hier nicht gibt. |
401 | invalid_token | Bearer fehlt, ist unbekannt oder abgelaufen. |
403 | missing_scope | Das Token trägt den Scope dieses Endpunkts nicht. |
404 | not_found | Der Eintrag gehört nicht zum freigegebenen Anbieter — oder die Anfrage kam auf der falschen Subdomain an. |
409 | conflict | Der Zustand verbietet die Änderung — der Fehlerkörper nennt den Grund. |
429 | rate_limited | Kontingent erschöpft, siehe Retry-After. |
Jede Fehlerantwort trägt dieselbe Hülle: error.code benennt den Fehler, error.message sagt in einem Satz, was fehlt.
Rate Limits
Das Limit gilt pro Team, nicht pro Token.
| Zugang | Produktion | Sandbox |
|---|---|---|
| Hobby | 60 Anfragen/Minute | ohne Limit |
| Developer Mitgliedschaft | 10.000 Anfragen/Minute | ohne Limit |
Bei 429 sagt der Retry-After-Header, wie lange du warten sollst.