Skip to content

Commit 74576ec

Browse files
authored
feat(i18n): update translations (#1660)
1 parent 67e681d commit 74576ec

File tree

6 files changed

+1061
-5
lines changed

6 files changed

+1061
-5
lines changed

apps/docs/content/docs/de/tools/generic_webhook.mdx

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,210 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
2323
</svg>`}
2424
/>
2525

26+
## Übersicht
27+
28+
Der Generic Webhook-Block ermöglicht es Ihnen, Webhooks von jedem externen Dienst zu empfangen. Dies ist ein flexibler Auslöser, der jede JSON-Nutzlast verarbeiten kann und sich daher ideal für die Integration mit Diensten eignet, die keinen dedizierten Sim-Block haben.
29+
30+
## Grundlegende Verwendung
31+
32+
### Einfacher Durchleitungsmodus
33+
34+
Ohne ein Eingabeformat zu definieren, leitet der Webhook den gesamten Anforderungstext unverändert weiter:
35+
36+
```bash
37+
curl -X POST https://sim.ai/api/webhooks/trigger/{webhook-path} \
38+
-H "Content-Type: application/json" \
39+
-H "X-Sim-Secret: your-secret" \
40+
-d '{
41+
"message": "Test webhook trigger",
42+
"data": {
43+
"key": "value"
44+
}
45+
}'
46+
```
47+
48+
Greifen Sie in nachgelagerten Blöcken auf die Daten zu mit:
49+
- `<webhook1.message>` → "Test webhook trigger"
50+
- `<webhook1.data.key>` → "value"
51+
52+
### Strukturiertes Eingabeformat (Optional)
53+
54+
Definieren Sie ein Eingabeschema, um typisierte Felder zu erhalten und erweiterte Funktionen wie Datei-Uploads zu aktivieren:
55+
56+
**Konfiguration des Eingabeformats:**
57+
58+
```json
59+
[
60+
{ "name": "message", "type": "string" },
61+
{ "name": "priority", "type": "number" },
62+
{ "name": "documents", "type": "files" }
63+
]
64+
```
65+
66+
**Webhook-Anfrage:**
67+
68+
```bash
69+
curl -X POST https://sim.ai/api/webhooks/trigger/{webhook-path} \
70+
-H "Content-Type: application/json" \
71+
-H "X-Sim-Secret: your-secret" \
72+
-d '{
73+
"message": "Invoice submission",
74+
"priority": 1,
75+
"documents": [
76+
{
77+
"type": "file",
78+
"data": "data:application/pdf;base64,JVBERi0xLjQK...",
79+
"name": "invoice.pdf",
80+
"mime": "application/pdf"
81+
}
82+
]
83+
}'
84+
```
85+
86+
## Datei-Uploads
87+
88+
### Unterstützte Dateiformate
89+
90+
Der Webhook unterstützt zwei Dateieingabeformate:
91+
92+
#### 1. Base64-kodierte Dateien
93+
Zum direkten Hochladen von Dateiinhalten:
94+
95+
```json
96+
{
97+
"documents": [
98+
{
99+
"type": "file",
100+
"data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA...",
101+
"name": "screenshot.png",
102+
"mime": "image/png"
103+
}
104+
]
105+
}
106+
```
107+
108+
- **Maximale Größe**: 20MB pro Datei
109+
- **Format**: Standard-Daten-URL mit Base64-Kodierung
110+
- **Speicherung**: Dateien werden in sicheren Ausführungsspeicher hochgeladen
111+
112+
#### 2. URL-Referenzen
113+
Zum Übergeben vorhandener Datei-URLs:
114+
115+
```json
116+
{
117+
"documents": [
118+
{
119+
"type": "url",
120+
"data": "https://example.com/files/document.pdf",
121+
"name": "document.pdf",
122+
"mime": "application/pdf"
123+
}
124+
]
125+
}
126+
```
127+
128+
### Zugriff auf Dateien in nachgelagerten Blöcken
129+
130+
Dateien werden in `UserFile`Objekte mit folgenden Eigenschaften verarbeitet:
131+
132+
```typescript
133+
{
134+
id: string, // Unique file identifier
135+
name: string, // Original filename
136+
url: string, // Presigned URL (valid for 5 minutes)
137+
size: number, // File size in bytes
138+
type: string, // MIME type
139+
key: string, // Storage key
140+
uploadedAt: string, // ISO timestamp
141+
expiresAt: string // ISO timestamp (5 minutes)
142+
}
143+
```
144+
145+
**Zugriff in Blöcken:**
146+
- `<webhook1.documents[0].url>` → Download-URL
147+
- `<webhook1.documents[0].name>` → "invoice.pdf"
148+
- `<webhook1.documents[0].size>` → 524288
149+
- `<webhook1.documents[0].type>` → "application/pdf"
150+
151+
### Vollständiges Beispiel für Datei-Upload
152+
153+
```bash
154+
# Create a base64-encoded file
155+
echo "Hello World" | base64
156+
# SGVsbG8gV29ybGQK
157+
158+
# Send webhook with file
159+
curl -X POST https://sim.ai/api/webhooks/trigger/{webhook-path} \
160+
-H "Content-Type: application/json" \
161+
-H "X-Sim-Secret: your-secret" \
162+
-d '{
163+
"subject": "Document for review",
164+
"attachments": [
165+
{
166+
"type": "file",
167+
"data": "data:text/plain;base64,SGVsbG8gV29ybGQK",
168+
"name": "sample.txt",
169+
"mime": "text/plain"
170+
}
171+
]
172+
}'
173+
```
174+
175+
## Authentifizierung
176+
177+
### Authentifizierung konfigurieren (optional)
178+
179+
In der Webhook-Konfiguration:
180+
1. Aktiviere "Authentifizierung erforderlich"
181+
2. Setze einen geheimen Token
182+
3. Wähle den Header-Typ:
183+
- **Benutzerdefinierter Header**: `X-Sim-Secret: your-token`
184+
- **Authorization Bearer**: `Authorization: Bearer your-token`
185+
186+
### Verwendung der Authentifizierung
187+
188+
```bash
189+
# With custom header
190+
curl -X POST https://sim.ai/api/webhooks/trigger/{webhook-path} \
191+
-H "Content-Type: application/json" \
192+
-H "X-Sim-Secret: your-secret-token" \
193+
-d '{"message": "Authenticated request"}'
194+
195+
# With bearer token
196+
curl -X POST https://sim.ai/api/webhooks/trigger/{webhook-path} \
197+
-H "Content-Type: application/json" \
198+
-H "Authorization: Bearer your-secret-token" \
199+
-d '{"message": "Authenticated request"}'
200+
```
201+
202+
## Best Practices
203+
204+
1. **Eingabeformat für Struktur verwenden**: Definiere ein Eingabeformat, wenn du das erwartete Schema kennst. Dies bietet:
205+
- Typvalidierung
206+
- Bessere Autovervollständigung im Editor
207+
- Datei-Upload-Funktionen
208+
209+
2. **Authentifizierung**: Aktiviere immer die Authentifizierung für Produktions-Webhooks, um unbefugten Zugriff zu verhindern.
210+
211+
3. **Dateigrößenbeschränkungen**: Halte Dateien unter 20 MB. Verwende für größere Dateien stattdessen URL-Referenzen.
212+
213+
4. **Dateiablauf**: Heruntergeladene Dateien haben URLs mit einer Gültigkeit von 5 Minuten. Verarbeite sie umgehend oder speichere sie an anderer Stelle, wenn sie länger benötigt werden.
214+
215+
5. **Fehlerbehandlung**: Die Webhook-Verarbeitung erfolgt asynchron. Überprüfe die Ausführungsprotokolle auf Fehler.
216+
217+
6. **Testen**: Verwende die Schaltfläche "Webhook testen" im Editor, um deine Konfiguration vor der Bereitstellung zu validieren.
218+
219+
## Anwendungsfälle
220+
221+
- **Formularübermittlungen**: Empfange Daten von benutzerdefinierten Formularen mit Datei-Uploads
222+
- **Drittanbieter-Integrationen**: Verbinde mit Diensten, die Webhooks senden (Stripe, GitHub usw.)
223+
- **Dokumentenverarbeitung**: Akzeptiere Dokumente von externen Systemen zur Verarbeitung
224+
- **Ereignisbenachrichtigungen**: Empfange Ereignisdaten aus verschiedenen Quellen
225+
- **Benutzerdefinierte APIs**: Erstelle benutzerdefinierte API-Endpunkte für deine Anwendungen
226+
26227
## Hinweise
27228

28229
- Kategorie: `triggers`
29230
- Typ: `generic_webhook`
231+
- **Dateiunterstützung**: Verfügbar über Eingabeformat-Konfiguration
232+
- **Maximale Dateigröße**: 20 MB pro Datei

0 commit comments

Comments
 (0)