Notifications API

Why use this API?

Clients can use the Notification API to send notifications to their customers using different channels.

circle-info

Notification delivery is currently limited to SMS only.

Participating parties

circle-info

See here for definitions.

  • Clickatell

  • Client

  • Recipient

Getting started with the Notifications API

To interface with Clickatell, the following needs to be set up, configured, and tested:

1

Integrate with Security Service API

  • Follow the instructions in the Security Service API quick-start guide to request a token with your client_secret and client_id.

  • Use the API_key and access_token in the following request (Step 2).

2

Call Notification API (this API)

  • Add the API_key and access_token to the request header.

  • Use the client_id supplied during integration.

A high-level view of this interface.