Erlebnisse
Ein Erlebnis steuert alles, was der Unterzeichner sieht und erhält, wenn ihm ein Dokument zugesandt wird – die E-Mails, die Unterzeichnungsseite, das Branding und das Verhalten. Jede Gruppe hat mindestens ein Erlebnis (das Standarderlebnis), und Sie können mehrere Erlebnisse für verschiedene Anwendungsfälle erstellen.
Was ein Erlebnis steuert
E-Mails
- Betreffzeilen für Einladungs-, Erinnerungs-, Abschluss- und Ablehnungsemails
- E-Mail-Header-Text und Unter-Header-Text
- Zusätzlicher E-Mail-Text im Hauptteil
- E-Mail-Logo (separat hochgeladen über die upload Abfrage)
- Ob ein Entwurfs-PDF an die Einladungsemail angehängt wird
Unterzeichnungsseite
- Branding-Farben (Hintergrund, Rahmen, Buttons, Text)
- Logo und Logomaße
- Überschrift und Haupttext, die dem Unterzeichner gezeigt werden
- Zustimmungs-Checkboxen (
signingPageAgreeTicks) — verlangen, dass der Unterzeichner den Bedingungen vor dem Unterschreiben zustimmt - Ob der Unterzeichner das Dokument ablehnen kann (
signingPageRejectButton) - Text, der nach der Unterzeichnung angezeigt wird (
signingPageText) - Sitzungstimeout (
signingSessionTime)
Signaturalternativen
- Eingabemethoden für die Unterschrift: zeichnen mit Maus (
signatureMouse), tippen (signatureType), Bild hochladen (signatureUpload) - Ob die Wiederverwendung einer früheren Unterschrift erlaubt ist (
allowSignatureReuse) - Was der Unterschrift angehängt wird: Namensformat (
signatureAppend), Datums-/IP-Format (signatureAppendExtra) - Stiftdurchmesser bei gezeichneten Unterschriften
- Ob ein digitales Zertifikat enthalten ist (
signatureCertificate)
Verhalten
emailSendSequence— an alle Empfänger gleichzeitig senden (0) oder nacheinander (1)canReassign— dem Unterzeichner erlauben, das Dokument an jemand anderen weiterzuleitenforwarding— dem Unterzeichner erlauben, das Dokument weiterzuleitenpostSignEmail— nach der Unterzeichnung eine Bestätigungsemail sendenpostSignAttach— das unterschriebene PDF an die Bestätigungsemail anhängen- Anforderungen an Zeugen (
witnessingRequiresSignerSMS,witnessingRequiresWitnessSMS)
Sprache
language— der Sprachcode für die Benutzeroberfläche des Unterzeichners (z. B.en,fr,de). Dies steuert die Sprache der systemgenerierten Texte auf der Unterzeichnungsseite und in E-Mails.
Wann mehrere Erlebnisse verwenden
- Verschiedene Sprachen — erstellen Sie pro Sprache ein Erlebnis für internationale Unterzeichner
- Verschiedenes Branding — Weißbeschriftung des Unterzeichnungserlebnisses für verschiedene Kunden oder Produkte
- Verschiedene Unterzeichnungsregeln — ein Erlebnis verlangt Zustimmungs-Checkboxen, ein anderes nicht
- Intern vs. extern — ein vereinfachtes Erlebnis für interne Mitarbeiter, ein formelleres für externe Kunden
Verwendung von Erlebnissen mit der API
Standard festlegen
Ein Erlebnis pro Gruppe ist mit defaultExperience: true markiert. Dokumente, die ohne Angabe eines Erlebnisses versendet werden, verwenden dieses.
Bei Sendung angeben
Übergeben Sie experience bei jedem Empfänger in der send Mutation, um das Standard zu überschreiben:
mutation {
send(input: {
groupId: "Z3JwMTIzNDU2"
templateId: "dHBsMTIzNDU2"
title: "Contract - French"
recipients: [
{
firstName: "Marie"
lastName: "Dupont"
email: "marie@example.com"
role: "Signer"
experience: "ZXhwMTIzNDU2"
}
]
})
}
CRUD-Operationen
createExperience— ein neues Erlebnis in einer Gruppe erstellenupdateExperience— ein bestehendes Erlebnis änderndeleteExperience— ein Erlebnis entfernencopyExperience— ein Erlebnis duplizieren (optional in eine andere Gruppe)
Verwandte
- Erlebnistyp-Referenz — vollständige Feldliste
- send-Mutation — Empfänger-
experiencebei der Sendung angeben - Gruppentyp — Erlebnisse gehören zu einer Gruppe über
experienceConnection