Entry point

There are two entry points for messages, depending on which rule you apply:

• GetMessages
• GetUnreadMessages

Classification

Participants manually categorize all messages they send. The category they select will appear in the API response.

Throttling to mitigate thresholds and adverse performance

The current soft threshold is 50 API calls per second, which is contingent on scaling. When retrieving messages via the API, we advise you to pull hourly messages from the platform.

Pulling doesn’t have to be real-time. You can throttle based on a timer and pull messages using the “created_after” parameter. This enables you to get the last hour’s worth of messages.

Example

Here is an example of the results you can expect to get when calling the message suite APIs (current version):

 {

  "results": [

    {

      "notification_processed": false,

      "type": "message",

      "data": {

        "study_id": "65537a1079748eb67b215235",

        "category": "technical-issues"

      },

      "datetime_created": "2023-12-01T12:11:52.034000Z",

      "body": "Hello hello hello",

      "datetime_updated": "2023-12-01T12:11:52.034000Z",

      "id": "6569cd882f0343a079d8f4d2",

      "channel_id": "1fce277896d7620030097000b27823b67893852daa51e68bb38f7c9044856d",

      "sender_id": "65537a1072088eb67b215235"

    }

  ],

  "_links": {

    "self": {

      "href": "http://localhost:8888/api/v1/messages/",

      "title": "Current"

    }

  }

}