Quick start guide
Start using Alerting Hub in a few simple steps.
In this Quick Start guide, we’ll show you how to obtain your free sample API key, what you can use your key for, how to send an alert and collect the results.
Start using Alerting Hub in a few simple steps.
In this Quick Start guide, we’ll show you how to obtain your free sample API key, what you can use your key for, how to send an alert and collect the results.
Complete the API key request form below to automatically obtain a sample API key. The key will be emailed to the address you provide and will be valid for a short period; usually a week. You can use the same sample API key for both live and sandbox working. However, you can only have one sample API key at a time per email address.
For live working, the sample API key allows you to send a small number of real SMS/emails and make a small number of time-limited calls to a restricted list of recipients (specified in the form below). The sample API keys also restrict who you appear as when sending alerts, so certain elements such as the sender are ignored.
By using a sample API key you are agreeing to adhere to the Alerting Hub usage policy.
Send a real, live, alert by calling our sendalert API using one of the following methods (see the API guide for more details):
Sandbox testing is also available, when using the sandbox the amount of SMS, emails and calls that can be sent are much greater.
Examples of sending an alert (contained in ‘myalert.json’) via curl:
Once you’ve sent an alert, you may well wish to get updates on how it has progressed. You can get those updates by one of the following methods:
This site uses cookies. By continuing to browse the site, you are agreeing to our use of cookies.
OKLearn moreWe may request cookies to be set on your device. We use cookies to let us know when you visit our websites, how you interact with us, to enrich your user experience, and to customize your relationship with our website.
Click on the different category headings to find out more. You can also change some of your preferences. Note that blocking some types of cookies may impact your experience on our websites and the services we are able to offer.
These cookies are strictly necessary to provide you with services available through our website and to use some of its features.
Because these cookies are strictly necessary to deliver the website, refuseing them will have impact how our site functions. You always can block or delete cookies by changing your browser settings and force blocking all cookies on this website. But this will always prompt you to accept/refuse cookies when revisiting our site.
We fully respect if you want to refuse cookies but to avoid asking you again and again kindly allow us to store a cookie for that. You are free to opt out any time or opt in for other cookies to get a better experience. If you refuse cookies we will remove all set cookies in our domain.
We provide you with a list of stored cookies on your computer in our domain so you can check what we stored. Due to security reasons we are not able to show or modify cookies from other domains. You can check these in your browser security settings.
These cookies collect information that is used either in aggregate form to help us understand how our website is being used or how effective our marketing campaigns are, or to help us customize our website and application for you in order to enhance your experience.
If you do not want that we track your visit to our site you can disable tracking in your browser here:
We also use different external services like Google Webfonts, Google Maps, and external Video providers. Since these providers may collect personal data like your IP address we allow you to block them here. Please be aware that this might heavily reduce the functionality and appearance of our site. Changes will take effect once you reload the page.
Google Webfont Settings:
Google Map Settings:
Google reCaptcha Settings:
Vimeo and Youtube video embeds:
The following cookies are also needed - You can choose if you want to allow them:
You can read about our cookies and privacy settings in detail on our Privacy Policy Page.
Privacy policy