Vereinsantrag
Handbuch
DeveloperVereinsantrag.online
Handbuch
DeveloperVereinsantrag.online
  1. Handbuch
  • Wilkommen zu Vereinsantrag 🎉
  • Registrierung und Vereinsdaten
  • Mitgliedschaften und Abteilungen
  • Formulare konfigurieren und veröffentlichen
  • Formular Design
  • Weitere Felder hinzufĂĽgen
  • Datenschutz
  • Einstellungen
  • Arbeiten mit Online-Anträgen
    • Export
    • Anträge korrigieren
    • Antrags-Historie
  • Developer
    • Welcome to the developer portal
    • Get your token
    • Rate-Limiting
    • API-Reference
      • Authentication
        • AuthenticationService
          • /auth/login
          • /auth/refresh
          • /auth/manage/info
          • /auth/manage/info
        • Users
          • Get all users for the current club (Admin only)
          • Create a new user in the current club without password - user receives email invitation (Admin only)
          • Get user by ID within the current club
          • Update user details within the current club
          • Delete a user from the current club (Admin only)
          • Resend password setup email to a user (Admin only)
          • Get available roles (Admin only)
      • Managing your club
        • Club
          • Gets the information of the club.
          • Changes the information of the club.
          • Gets the logo of the club.
          • Changes the logo of the club.
        • Department
          • Retrieves all departments for the current club.
          • Creates a new department.
          • Retrieves a specific department by its ID.
          • Deletes a specific department by its ID.
          • Modifies an existing department.
          • Retrieves the settings for the departments.
          • Updates the settings for the departments.
        • Forms
          • Get Membership Form
          • Modify Membership Form
          • Get Cancellation Form
          • Modify Cancellation Form
          • Get Form Design
          • Updates form Design
        • Membership
          • Retrieves all memberships for the current club.
          • Creates a new membership.
          • Retrieves a specific membership by its ID.
          • Deletes a specific membership by its ID.
          • Modifies an existing membership.
        • CustomField
          • Retrieves all custom fields for the current club.
          • Creates a new custom field.
          • Retrieves a specific custom field by its internal name.
          • Deletes a specific custom field by its internal name.
          • Partially modifies an existing custom field.
        • DataPrivacy
          • Retrieves the data privacy settings for the club.
          • Updates the data privacy settings for the club.
        • Settings
          • Get email template
          • Set email template
          • Reset email template
          • Get system email template
          • Get SMTP settings
          • Set SMTP settings
          • Test SMTP connection
          • Get available placeholders for email template
          • Get notification settings (who receives emails on new submissions)
          • Save notification settings
        • Webhooks
          • List webhooks
          • Create webhook
          • Update webhook
          • Delete webhook
          • Rotate secret
          • Test webhook
          • Delivery history
      • Submits
        • Cancellations
          • Get cancellation by id
          • Delete cancellation
          • Update cancellation submission
          • Create new cancellation
          • Get cancellation PDF
          • Get cancellation CSV
          • Export cancellation as text
          • Confirm cancellation
          • Resends the confirmation email for a cancellation application
          • Retrieves the history for a specific cancellation submission.
        • Changes
          • Create a new change request
          • Get change request by ID
          • Delete change request
          • Update change submission
          • Get change request PDF
          • Get change request CSV
          • Export change request as text
          • Confirm change request
          • Resends the confirmation email for a change membership application
          • Retrieves the history for a specific change submission.
        • Memberships
          • Creates a new membership application
          • Retrieves a membership application
          • Deletes a membership application
          • Update membership application
          • Exports a membership application as PDF
          • Exports a membership application as CSV
          • Exports a membership application as text
          • Exports a membership application as verein.cloud® CSV
          • Confirms a membership application
          • Resends the confirmation email for a membership application
          • Retrieves the history for a specific membership submission.
        • Submits
          • Retrieves all submissions.
          • Accepts a submission.
          • Denies a submission.
          • Starts a PDF export job
          • Downloads exported files as ZIP
          • Returns export job progress
          • Starts a CSV export job
          • Starts a verein.cloud® export job
      • Reporting
        • Dashboard
          • Gets the count of new memberships.
          • Gets the count of new changes.
          • Gets the count of new cancellations.
          • Gets the membership chart data.
          • Gets all dashboard KPI values in a single call.
          • Gets the submission trend (memberships, changes, cancellations and net development) per week or month.
          • Gets the age distribution of new members (including family members) in the period.
          • Gets the gender distribution of new members (including family members) in the period.
          • Gets the most popular departments by new memberships in the period.
          • Gets the distribution of membership types in the period.
          • Gets the payment method distribution of new memberships in the period.
          • Gets the application funnel (received, e-mail confirmed, accepted, rejected) for the period.
          • Gets the average processing time per month for the period.
          • Gets the most common zip codes of new members in the period.
          • Gets the webhook delivery trend (succeeded vs. failed) per month for the period.
  • Schemas
    • BackgroundImageSettings
    • CancellationMode
    • AccessTokenResponse
    • BackgroundSettings
    • CancellationPatchDto
    • CreateUserRequest
    • CancellationSubmit
    • ChangeClubInfo
    • ForgotPasswordRequest
    • CancellationSubmitPatchRequest
    • HttpValidationProblemDetails
    • ChangeCustomFieldSchema
    • InfoRequest
    • CancellationSubmitResponse
    • ChangeMembershipSchema
    • ChangePatchDto
    • InfoResponse
    • ClubInfo
    • ClubLogo
    • ChangeSubmitPatchRequest
    • LoginRequest
    • ChangesSubmit
    • RefreshRequest
    • ConsentMediaType
    • CustomDesignSettings
    • RegisterRequest
    • CustomFieldCategory
    • CustomFieldPatchDto
    • ResendConfirmationEmailRequest
    • ResetPasswordRequest
    • CustomFieldSchema
    • FamiliySubmit
    • TwoFactorRequest
    • FamilyMemberPatchDto
    • CustomFieldType
    • TwoFactorResponse
    • Gender
    • DataPrivacySchema
    • UpdateUserRequest
    • MembershipPatchDto
    • DepartmentSchema
    • MembershipPatchRequest
    • UserResponse
    • DepartmentSettingsSchema
    • EMailTemplateType
    • UserRole
    • MembershipSubmit
    • MembershipSubmitResponse
    • File
    • FormCancellation
    • PaymentMethod
    • ProblemDetails
    • FormDesign
    • FormMembership
    • StartExportJobRequest
    • GetEmailTemplateResponse
    • SubmitAcceptRequest
    • MembershipDepartmentPriceSchema
    • SubmitDenyRequest
    • MembershipPriceInterval
    • SubmitHistoryResponse
    • MembershipSchema
    • SubmitHistoryType
    • SubmitResponse
    • NotificationSettingsReadDto
    • SubmitState
    • NotificationSettingsWriteDto
    • NotificationUserSelectionDto
    • PatchCustomFieldSchema
    • PlaceholderCategory
    • PlaceholderDataType
    • PlaceholderDefinition
    • SetEmailTemplateRequest
    • SmtpSettingsReadDto
    • SmtpSettingsWriteDto
    • SmtpTestResultDto
    • ValidationProblemDetails
    • WebhookDeliveryDto
    • WebhookDeliveryStatus
    • WebhookEventType
    • WebhookReadDto
    • WebhookSecretDto
    • WebhookTestResultDto
    • WebhookWriteDto
  1. Handbuch

Einstellungen

Sofern Sie die Rolle Vereinsadministrator besitzen, gelangen Sie in die Einstellungen ĂĽber das kleine Zahnrad in der rechten oberen Ecke.
Ă–ffnen der Einstellungen

Benutzer#

Die Benutzerverwaltung ist erst ab der Silber-Edition verfĂĽgbar
Die Benutzerverwaltung in Vereinsantrag ermöglicht es, mehrere Vereinsmitarbeiter:innen mit unterschiedlichen Rechten zu verwalten. So kann die Arbeit im Verein aufgeteilt und organisiert werden.
In der BenutzerĂĽbersicht findest du eine Liste aller angelegten Benutzer deines Vereins.
🔍 Über das Suchfeld kannst du Benutzer nach Name oder E-Mail filtern.
Liste der Benutzer

Neuer Benutzer anlegen#

Erstellen eines neuen Benutzers
Klicke auf den Button „Neuer Benutzer“, um eine neue Person mit Zugriffsrechten zum Verein einzuladen.
Folgende Angaben sind erforderlich:
Vorname
Nachname
E-Mail-Adresse (dient auch zur Anmeldung)
Rolle (siehe unten)
Der eingeladene Benutzer erhält eine E-Mail mit Zugangsinformationen.
đź’ˇ
Nach dem Erstellen des Benutzers, wird in der Liste ein kleines Symbol eingeblendet. Dies besagt, dass der Benutzer noch nicht aktiv ist bzw. noch kein Passwort hinterlegt hat.
Sollte der Benutzer keine Einladungs-Email erhalten haben, so lässt sich diese Einladung erneut versenden:

Benutzer bearbeiten#

Klicke auf das Drei-Punkte-MenĂĽ (â‹®) neben einem Benutzer, um folgende Aktionen durchzufĂĽhren:
Bearbeiten: Name oder Rolle ändern
Löschen: Benutzer vollständig entfernen (z. B. bei Austritt)

Rollen & Rechte#

Beim Erstellen oder Bearbeiten eines Benutzers kann eine von drei Rollen vergeben werden:

1. Vereinsadministrator#

Voller administrativer Zugriff
Verwaltung aller Vereinsfunktionen
Benutzerverwaltung, Einstellungen, Formulare
Zugriff auf alle Vereinsdaten
Geeignet für: Vorstände oder IT-beauftragte Personen

2. Mitgliederverwalter#

Bearbeiten von Mitgliedsdaten
Anzeigen und Verwalten von Mitglieds-, Änderungs- und Kündigungenanträgen
Löschen von Mitglieds-, Änderungs- und Kündigungenanträgen
Annehmen und Ablehnen von Anträgen
Geeignet fĂĽr: Mitgliederverwaltung, Sekretariat

3. Antragseinsicht#

Nur-Lese-Zugriff
Anzeigen eingereichter Anträge
Keine Bearbeitung oder Verwaltung möglich
Geeignet fĂĽr: KassenprĂĽfer, Beisitzer, interessierte Vorstandsmitglieder

Technische Hinweise#

Die E-Mail-Adresse eines Benutzers kann nicht nachträglich über die Benutzerverwaltung geändert werden. Dies lässt sich nur durch den Benutzer in den jeweiligen Profileinstellungen ändern.
Ein Benutzer kann immer nur eine Rolle gleichzeitig haben.
Beim Löschen eines Benutzers werden keine Mitgliedsdaten gelöscht, sondern nur der Zugriff entfernt.
Die E-Mail Adresse muss eindeutig sein

E-Mail Vorlagen#

Das Bearbeiten der E-Mail Vorlagen ist erst ab der Gold-Edition verfĂĽgbar

Ăśbersicht#

Im Einstellungsbereich E-Mail Vorlagen können Sie die E-Mail-Texte für verschiedene Systembenachrichtigungen individuell anpassen. Sie wählen eine Vorlage aus, bearbeiten den Inhalt nach Ihren Anforderungen und speichern die Änderungen. Zusätzlich können Sie jederzeit zur Systemvorlage zurückkehren oder eine Testmail versenden, um das Ergebnis zu überprüfen.
Ăśbersicht der E-Mail Vorlagen

Funktionsweise#

1.
Vorlage auswählen
Wählen Sie aus der Dropdown-Liste die gewünschte E-Mail-Vorlage aus, die Sie bearbeiten möchten (z.B. "Neuer Mitgliedsantrag (Mitglied)", "Antrag abgelehnt" usw.).



2.
Eigene Vorlage aktivieren
Aktivieren Sie die Option „Eigene E-Mail Vorlage verwenden“, um die Vorlage individuell zu gestalten. Ohne Aktivierung wird die Systemvorlage verwendet.



3.
Aktionen
Speichern: Vor dem Verlassen der Seite oder dem Wechsel zu einer anderen Vorlage, speichern Sie bitte Ihre getätigten Änderungen.
Systemvorlage wiederherstellen: Setzt die Vorlage auf den Standard zurĂĽck. Ihre angepasste Vorlage wird unwiederuflich entfernt.
Testmail senden: Sendet eine Test-E-Mail mit den aktuellen Einstellungen.


Platzhalter in E-Mail Vorlagen#

Um die E-Mails zu personalisieren, stehen Ihnen verschiedene Platzhalter zur VerfĂĽgung. Diese werden beim Versand automatisch durch die passenden Werte ersetzt.
Beispielhafte Platzhalter:
PlatzhalterBedeutung
$$FIRST_NAME$$Vorname des Empfängers
$$CLUB_NAME$$Name des Vereins
$$CLUB_FIRSTNAME$$Vorname des Vorstandsmitglieds
$$CLUB_LASTNAME$$Nachname des Vorstandsmitglieds
$$CLUB_ID$$Eindeutige ID des Vereins
$$CONFIRM_LINK$$Bei E-Mails mit Bestätigungs-Link
Verwendung:
Platzhalter werden im Text durch die entsprechenden Werte ersetzt. Beispiel:
Hallo $$FIRST_NAME$$, Willkommen bei $$CLUB_NAME$$!
Ergebnis in der E-Mail:
Hallo Max, Willkommen bei Sportverein Musterstadt!


Experten-Tipp
Sie können die E-Mail Vorlage auch als HTML direkt bearbeiten. Klicken Sie dazu in der Symbolleiste auf dieses Icon:

image.png

Hinweise#

Die verfügbaren Platzhalter können je nach Vorlage variieren.
Achten Sie darauf, die Platzhalter exakt zu schreiben (inklusive der doppelten Dollarzeichen).
Änderungen an den Vorlagen sind ab der Gold-Edition möglich.

E-Mail Versand#

Das Festlegen eines eigenen SMTP-Servers ist erst ab der Gold-Edition verfĂĽgbar
Eigenen SMTP-Server definieren

Ăśbersicht#

In diesem Dialog können Sie konfigurieren, wie Ihr Vereinssystem E-Mails versendet. Sie haben die Wahl zwischen dem Standard-SMTP-Server von Vereinsantrag und einem eigenen SMTP-Server.

Optionen#

1. Vereinsantrag System-SMTP verwenden#

Beschreibung: Alle E-Mails werden ĂĽber den zentralen Server von Vereinsantrag versendet.
Absender: info@vereinsantrag.de
Vorteil: Keine weitere Konfiguration notwendig.

2. Benutzerdefinierten SMTP-Server verwenden#

Beschreibung: E-Mails werden ĂĽber Ihren eigenen SMTP-Server versendet.
Hinweis: Diese Option ist ab der Gold-Edition verfĂĽgbar.
Felder fĂĽr die SMTP-Konfiguration#
FeldBeschreibungPflichtfeld
SMTP ServerAdresse Ihres SMTP-Servers (z.B. smtp.example.com)âś”
PortPort des SMTP-Servers (z.B. 587, 465). Sollte Port 587 nicht zum Erfolg fĂĽhren, versuchen Sie Port 465 mit SSL.âś”
BenutzernameBenutzername fĂĽr die Anmeldung am SMTP-Server. MeiĂźtens die E-Mail Adresseâś”
PasswortPasswort fĂĽr die Anmeldung am SMTP-Serverâś”
SSL/TLS verwendenAktiviert die verschlĂĽsselte Verbindung-
Absender E-MailE-Mail-Adresse, die als Absender genutzt wirdâś”
Absender NameName, der als Absender angezeigt wird. Falls leer, wird die Absender E-Mail Adresse verwendet.-
Hinweis: Alle Felder mit * sind Pflichtfelder.
Bei manchen E-Mail Anbietern (z.B. GMAIL) ist nicht das Benutzerpasswort sondern ein eigen erstelltes App-Passwort notwendig. Informieren Sie sich hier bei Ihrem Anbieter nach den erforderlichen Daten.

Aktionen#

Speichern: Ăśbernimmt die Einstellungen. Die Felder werden vor dem Speichern validiert.
Verbindungstest: PrĂĽft, ob die SMTP-Daten korrekt sind und eine Verbindung hergestellt werden kann. Das Ergebnis wird angezeigt.

Hinweise zur Nutzung#

Wenn Sie den System-SMTP verwenden, mĂĽssen keine weiteren Angaben gemacht werden.
Bei Auswahl des eigenen SMTP-Servers mĂĽssen alle Pflichtfelder ausgefĂĽllt werden.
Bei Fehlern in der Eingabe werden diese direkt angezeigt.
Der Verbindungstest hilft, Konfigurationsfehler frĂĽhzeitig zu erkennen.

Beispiel fĂĽr SMTP-Konfiguration#

FeldBeispielwert
SMTP Serversmtp.gmail.com
Port587
Benutzernameihr.email@gmail.com
PasswortIhrPasswort123
SSL/TLS verwendenâś”
Absender E-Mailihr.email@gmail.com
Absender NameIhr Vereinsname
Bei Problemen mit dem Versand prĂĽfen Sie bitte die Zugangsdaten und die Einstellungen Ihres E-Mail-Anbieters.

Webhooks#

Webhooks sind ab der Gold-Edition verfĂĽgbar
Webhooks definieren
Mit Webhooks benachrichtigt Vereinsantrag Ihre eigenen Systeme automatisch und in Echtzeit, sobald in Ihrem Verein bestimmte Ereignisse eintreten – zum Beispiel wenn ein neuer Antrag eingeht oder angenommen wird. So lassen sich Anträge ohne manuelle Schritte an ein CRM, eine Buchhaltung oder ein Automatisierungs-Tool weiterreichen.
Technisch sendet Vereinsantrag dazu eine HTTP-POST-Anfrage mit den Ereignisdaten an eine von Ihnen hinterlegte Adresse (die „Ziel-URL").

Webhook einrichten#

1.
Ă–ffnen Sie die Einstellungen und wechseln Sie zum Tab Webhooks.
2.
Klicken Sie auf Neuer Webhook.
3.
FĂĽllen Sie die Felder aus:
Name – ein frei wählbarer Name zur Wiedererkennung, z. B. „CRM-Integration".
Ziel-URL – die https-Adresse, an die die Daten gesendet werden.
Events – wählen Sie ein oder mehrere Ereignisse aus, bei denen benachrichtigt werden soll.
Aktiv – nur aktive Webhooks erhalten Nachrichten.
4.
Nach dem Speichern wird Ihnen einmalig das Secret angezeigt.
⚠️ Wichtig: Das Secret wird nur dieses eine Mal im Klartext angezeigt. Kopieren Sie es und bewahren Sie es sicher auf – es wird zum Prüfen der Signatur benötigt. Geht es verloren, können Sie jederzeit ein neues erzeugen.

VerfĂĽgbare Ereignisse#

Anzeige im DialogWert in der NachrichtWird ausgelöst, wenn …
Antrag eingegangenApplicationReceivedein neuer Antrag (Beitritt, Änderung oder Kündigung) eingegangen ist
E-Mail (DOI) bestätigtEmailConfirmedder Antragsteller seine E-Mail-Adresse bestätigt hat
Antrag akzeptiertApplicationAcceptedein Antrag angenommen wurde
Antrag abgelehntApplicationRejectedein Antrag abgelehnt wurde
Ein Webhook erhält ausschließlich die Ereignisse, die Sie ihm zugeordnet haben.

Webhooks verwalten#

In der Ăśbersicht finden Sie zu jedem Webhook ein MenĂĽ (â‹®) mit folgenden Aktionen:
Verlauf – zeigt die letzten Zustellungen mit Status, HTTP-Antwortcode, Dauer und ggf. Fehlermeldung.
Testen – sendet eine Beispiel-Nachricht an die Ziel-URL, um die Verbindung zu prüfen.
Secret neu erzeugen – erstellt ein neues Secret. Das bisherige wird sofort ungültig; Ihre Integration muss anschließend auf das neue Secret umgestellt werden.
Bearbeiten – Name, URL, Events und den Aktiv-Status ändern. Das Secret bleibt dabei unverändert.
Löschen – entfernt den Webhook samt seiner Zustellungs-Historie.
💡 Im Dashboard lässt sich zusätzlich die Kachel „Webhook-Zustellungen" einblenden. Sie zeigt erfolgreiche und fehlgeschlagene Zustellungen im Zeitverlauf – wahlweise über alle oder pro Webhook.

Previous
Datenschutz
Next
Arbeiten mit Online-Anträgen
Built with