Easy Guide: Connecting Your Club System to the TNZ National Database
Tips for clubs and developers:
- Start with test data, not real members
- Use "DEBUG": false in normal use
- Check for error messages in responses
If data is rejected, TNZ can usually tell you which field is missing or incorrect.
This guide is written for club volunteers with limited technical experience. It explains, in plain language, how a club’s system (or IT helper) can send player data to the Tennis New Zealand (TNZ) National Database using the official TNZ Player Webhook API.
You do not need to fully understand programming to follow this guide, but you will likely need help from:
- Your club’s software provider, or
- A volunteer with basic IT or web knowledge
What Is This API and Why Does It Matter?
An API (Application Programming Interface) is a secure way for your club’s system to automatically send player information to Tennis New Zealand.
This connection allows TNZ to:
- Know who is playing tennis nationally
- Track memberships and participation
- Send national communications and offers (only if players agree)
Your club does not log into TNZ and type this information in manually. Instead, your system sends it automatically using the webhook.
What Information Does TNZ Receive?
There are three main types of data your club can send:
- Member participation records (most common)
- Casual player records (non-members)
- Contact detail updates (mainly marketing consent)
Each type is sent to a different web address (URL) and uses a structured data format called JSON .
What You Need Before You Start
Before any connection can be set up, your club will need the following:
From Tennis New Zealand
- API username
- API password
These are provided privately by TNZ administration. Email them here with
1. Your Club Name, 2. Your Role & Contact Information
From Your Club
- A club system that can send data via API (or a developer volunteer)
- A unique External Source Club ID (usually a generated ID or TNZ-provided)
- Agreement on when data is sent (e.g. new signup, renewal, cancellation)
Sending Member Participation Records
When to Use This
Use this when a player:
- Joins the club
- Renews membership
- Changes membership status
Web Address (URL)
https://tnzapi.azurewebsites.net/externalapi/SendClubData
|
Field name
|
What it means
|
Example
|
|
RecordType
|
Must always be MEMBER
|
MEMBER
|
|
RecordSource
|
Which system is sending the data
|
CLUBSPARK
|
|
ExternalSourceContactId
|
Unique ID for the person in your system
|
0843caa9-739f-411e-9449-6cc3cb08d496
|
|
FirstName
|
Player’s first name
|
Ava
|
|
LastName
|
Player’s last name
|
Shao
|
|
BirthDate
|
Player’s date of birth
|
2010-08-22
|
|
Gender
|
Player’s gender
|
female
|
|
EmailAddress
|
Player’s email address
|
ava@example.com
|
|
ExternalSourceClubId
|
Unique ID for your club
|
d9eb3996-9338-4b8b-81a8-6fb19cfefb27
|
|
ClubName
|
Official club name
|
Example Tennis Club
|
|
ExternalSourcePackageId
|
Unique ID for the membership package
|
1ab07b30-157e-415e-bc6f-b5cc6a46b57a
|
|
PackageName
|
Name of the membership
|
Junior
|
|
ExternalSourceMembershipId
|
Unique ID for this membership
|
c508e4cd-bb39-41ec-b318-79559c8ceec0
|
|
StartDate
|
Membership start date
|
2025-01-01
|
|
EndDate
|
Membership end date
|
2025-12-31
|
|
Status
|
Membership status
|
active
|
|
Type
|
Contact type (1, 2, or 3)
|
1
|
|
CanSendOffers
|
Marketing consent
|
Yes / No
|
Your system sends this automatically when membership changes.
Sending Casual Player Records (Non-Members)
When to Use This
Use this when:
- Someone books a court casually
- A non-member plays in an event
Web Address (URL)
https://tnzapi.azurewebsites.net/externalapi/SendClubDataCasual
|
Field name
|
What it means
|
Example
|
|
RecordType
|
Must always be CASUAL
|
CASUAL
|
|
RecordSource
|
Which system is sending the data
|
CLUBSPARK
|
|
FirstName
|
Player’s first name
|
Gabrielle
|
|
LastName
|
Player’s last name
|
Martin
|
|
BirthDate
|
Player’s date of birth
|
1958-04-11
|
|
Gender
|
Player’s gender
|
female
|
|
EmailAddress
|
Player’s email address
|
example@email.com
|
|
ExternalSourceClubId
|
Unique ID for your club
|
d2f7c5b1-7cba-4447-8c2e-616d6f9c2d7f
|
|
ClubName
|
Official club name
|
Example Tennis Club
|
|
ClubEmail
|
Club contact email
|
info@exampleclub.org.nz
|
|
Town
|
City or town
|
Auckland
|
|
Postcode
|
Postcode
|
0622
|
|
StartDate
|
Date of casual play
|
2025-01-15
|
|
Type
|
Contact type (1, 2, or 3)
|
3
|
|
CanSendOffers
|
Marketing consent
|
Yes / No
|
Key Differences from Members
- RecordType = CASUAL
- No membership package required
- Still requires name, birthdate, club, and consent
This helps TNZ track overall participation in tennis .
API Updates
For ongoing updates view the swagger documentation on the API. http://tnzapi.azurewebsites.net/swagger