Notify Service: API Introduction
Notify Service has currently 1 service you can use which is:
- Notify Mobile - This api allows you to send notifications to a target device / user. You also get notified of the event when the user has interacted with your notification.
Getting Started
To get started, you need to have credits in your account and an api key that you will send together with your request and a webhook endpoint to receive the results. The webhook endpoint is necessary since it takes some time for the task to complete. Upon making a request, you will receive a response from the api that your request has been received. The api will process your request and post the results in your webhook endpoint.
You can find your credits and api key in your dashboard home page. The api key is automatically created for you when you signup. You get free credits for testing the api and may request to purchase for more. For the webhook endpoints, you need to save them in the Notify Service settings page under Services.
Webhook Flow
When making a request, please make sure to have the following:
- Set the value of the headers Content-Type to application/json
- Set the value of the headers x-api-key to your api key
- Set the method of the request to POST
- Provide the correct request body for the specific api. This will be discussed in more detail.
When your request does not meet the right format, you will receive the error in the response. If your request follows the right format but encounters an error during the processing of the task, you will receive the error in your webhook endpoint. Details on the error responses will be discussed in more detail.
API Endpoint
There is only one api endpoint for Notify services. The body of the request determines which service will be used in the endpoint. The service name you can use in this endpoint are:
Data Storage
The service saves notification that you sent temporarily. This means that users can access past notifications but eventually will be deleted. The minimum duration for this is 24 hours after which it will be deleted from the database. Messages once delivered to the user by the service are posted on your webhook endpoint. The service will also post to your webhook endpoint once the user interacts with the notification.