Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

Setting up Spark NZ

A guide on how to set up Spark NZ as your BYO SMS provider in GetHomeSafe

To configure Spark NZ, select it from the Provider dropdown in your SMS Provider Integration Settings.

Important Note: You must save your credentials before you can turn this integration on. Steps 1 to 3 are completed on your Spark NZ RESTV2 API configuration page.

Step 1: Allowlist our IP addresses

  • This is only required if you use an IP allowlist.
  • The Authorised IP Addresses section sits at the bottom of the page.
  • Leaving it empty accepts every address, but the moment it has one entry every other address is rejected, so ours must be on it. You can copy the required IP address directly from the setup page.

Step 2: Copy across your credentials

  • Under Authentication, input your RESTV2 Application Name and RESTV2 Password.
  • Use "Generate New Password" if you do not have the password, then Save to unlock steps 3 and 4.
  • Virtual Number / Sender ID: This is optional. You can enter a shortcode, mobile number, or registered Sender ID. Leave this blank to use your account default.

Step 3: Set your Status URL

  • You must save valid credentials from the steps above first, then your URL will appear here.

Step 4: Enable the integration

  • You must save valid credentials above first to complete this step.