Send Notification

This API allows partners to send notifications to users. The notifications can include a title, body, image URL, link, and a param if provided. The API supports different platform flavors such as Android, iOS, iPad and Web.

POST /notification/v1/notify

Send Notification

cURL

curl --request POST \
  --url https://api.eka.care/notification/v1/notify \
  --header 'Content-Type: application/json' \
  --header 'auth: <api-key>' \
  --data '
{
  "partner_payload": {
    "partner_doctor_id": "test-p1",
    "message": {
      "title": "test title",
      "body": "test body",
      "img": "img url"
    },
    "landing_page": "q",
    "params": {
      "action": "move",
      "aid": "12345",
      "status": "confirmed"
    }
  }
}
'

200

{
  "status": "success",
  "message": "Notification sent successfully."
}

Authorizations

auth · string · header · required

The API requires the following auth in headers for authentication.

Body

application/json

Notification payload

partner_payload · object · required

Show child attributes

Response

200

application/json

Webhook registered successfully.

status · string

The status of the notification.

Example:

"success"

message · string

The message for the notification.

Example:

"Notification sent successfully."