Skip to content

Notification

Retrieve notifications

This endpoint allows you to retrieve notifications associated with the user's group.

GET /api/v1/notification/
Example
{
  "external_id": "12345",
  "project_id": ""
}

Response

The response contains the list of available notifications, whether or not they have an associated email. List of possible notifications: "order_confirm" "change_status" "chat_ongoing" "service_activated" "order_terminate" "order_update" "study_request" "study_answered" "fon_offer" "fon_answered" "invoice_available"

Example
{
  "order_confirm": [
    "admin@example.com",
    "order@example.com"
  ],
  "change_status": [],
  "chat_ongoing": [
    "chat@example.com"
  ],
  "service_activated": [
    "service@example.com"
  ],
  "order_terminate": [
    "admin@example.com"
  ],
  "order_update": [
    "updates@example.com"
  ],
  "study_request": [
    "studies@example.com"
  ],
  "study_answered": [
    "studies@example.com"
  ],
  "fon_offer": [
    "fon@example.com"
  ],
  "fon_answered": [
    "fon@example.com"
  ],
  "invoice_available": [
    "billing@example.com"
  ]
}

Modify notification email recipients

This endpoint allows you to modify the emails to which each notification is sent. A notification can be sent to multiple emails. If a notification has no associated email, it will not be sent.

PATCH /api/v1/notification/configure/

Request parameters

List of possible notifications: "order_confirm" "change_status" "chat_ongoing" "service_activated" "order_terminate" "order_update" "study_request" "study_answered" "fon_offer" "fon_answered" "invoice_available"

Example
{
  "order_confirm": [
    "admin@example.com",
    "order@example.com"
  ],
  "change_status": [],
  "chat_ongoing": [
    "chat@example.com"
  ],
  "service_activated": [
    "service@example.com"
  ],
  "order_terminate": [
    "admin@example.com"
  ],
  "order_update": [
    "updates@example.com"
  ],
  "study_request": [
    "studies@example.com"
  ],
  "study_answered": [
    "studies@example.com"
  ],
  "fon_offer": [
    "fon@example.com"
  ],
  "fon_answered": [
    "fon@example.com"
  ],
  "invoice_available": [
    "billing@example.com"
  ]
}

Response

The response contains the list of available notifications, whether or not they have an associated email.

Example
{
  "order_confirm": [
    "admin@example.com",
    "order@example.com"
  ],
  "change_status": [],
  "chat_ongoing": [
    "chat@example.com"
  ],
  "service_activated": [
    "service@example.com"
  ],
  "order_terminate": [
    "admin@example.com"
  ],
  "order_update": [
    "updates@example.com"
  ],
  "study_request": [
    "studies@example.com"
  ],
  "study_answered": [
    "studies@example.com"
  ],
  "fon_offer": [
    "fon@example.com"
  ],
  "fon_answered": [
    "fon@example.com"
  ],
  "invoice_available": [
    "billing@example.com"
  ]
}