CherryMail
Zur Dokumentation springen
Entwicklerv1

Dokumentation ansehen

ÜbersichtAnleitungenSchnellstartAnleitungenAuthentifizierungAnleitungenLimits & FehlerAnleitungenWebhooksAnleitungenMCP-VerbindungenAnleitungenKonto abrufenKonto · GET /account/Domains auflistenDomains · GET /domains/Domain erstellenDomains · POST /domains/Eine Domain abrufenDomains · GET /domains/{id}/Domain löschenDomains · DELETE /domains/{id}/DNS-Anweisungen abrufenDomains · GET /domains/{id}/dns/
CherryMail-Entwicklerdokumentation durchsuchen
Entwickler /API-Referenz/ Webhooks
Webhooks

Abonnement erstellen

Erstelle ein signiertes HTTPS-Webhook-Abonnement. Speichere das einmalig angezeigte Signaturgeheimnis.

POST/api/v1/webhooks/
Berechtigung webhook
E-Mail-Ereignisse erfordern Zugriff auf das E-Mail-Postfach
Für das Abonnieren von Nachrichtenereignissen ist außerdem erforderlich read Berechtigung, ausgewählte Postfach-IDs und aktuelle Postfachberechtigungen.

Request-Header

Idempotency-Keystringerforderlich

Ein eindeutiger Schlüssel für diese beabsichtigte Aktion. Verwende ihn nur mit denselben Anfrageeingaben erneut.

Maximal 128 Zeichen

Anfragetext

Sende JSON mit Content-Type: application/json.

urlstringerforderlich

Öffentliche HTTPS-Callback-URL auf Port 443. Private Netzwerke und Weiterleitungen sind gesperrt.

Maximal 2048 Zeichen

eventsstring[]erforderlich

Genaue Ereignisnamen, für die du dich anmelden möchtest.

mailbox_idsinteger[]

E-Mail-Postfach-IDs, die von diesem Abonnement abgedeckt sind. Für E-Mail-Events sind aktuelle Berechtigungen erforderlich.

Standard: []

Antworten

200Erfolgreich

Dauerhafter Vorgangsbeleg mit dem Ergebnis dieses Endpunkts. Ausstehende Bereitstellung und SMTP-Annahme sind nicht gleichbedeutend mit der Bereitschaft der Ressource oder der Zustellung an den Empfänger.

400Ungültige Anfrage

Ungültige Eingabe oder fehlender Idempotenzschlüssel.

401Nicht authentifiziert

Fehlender, abgelaufener oder widerrufener Bearer-Token.

403Verboten

Falscher Verwendungszweck der Anmeldedaten, unzureichender Berechtigungsumfang oder fehlende Freigabe für das E-Mail-Postfach.

404Nicht gefunden

Ressource oder Nachricht nicht gefunden oder für diese Integration nicht verfügbar.

409Konflikt

Ressourcenkonflikt, veralteter Nachrichtenverweis, mehrdeutige Übermittlung oder Idempotenzkonflikt.

413Zu groß

Anfrage oder Nachricht überschreitet die unterstützte Größe.

429Ratenbegrenzung erreicht

Ratenlimit erreicht. Warte vor einem erneuten Versuch die unter Retry-After angegebene Zeit ab.

500Interner Serverfehler

Unerwarteter Serverfehler. Wende dich mit der Anfrage-ID an den Support. Prüfe unklare Schreibvorgänge, bevor du es erneut versuchst.

503Dienst nicht verfügbar

Integrationen deaktiviert oder ein vorgelagerter Dienst nicht verfügbar.

Unter Limits und Fehler findest du Informationen zur Wiederholungsbehandlung und zum Fehlerobjekt.