Real-time Notifications

Requires activating the bot user for your client application

Subscribe to receive events in real-time when data changes within the DocInk Platform. Below is a list of events that are currently supported. Don't see a specific event listed? Let us know as we're constantly adding new events.

New bot install
{
    "app_uuid": 1680332001,
    "org_uuid": 721192134,
    "event_name": "bot-installation",
    "event_time": "2021-02-17T16:30:16+00:00",
    "payload": {
        "scopes": [
            "administration-read",
            "administration-write",
            "clinical-read",
            "clinical-write",
            "communication-read",
            "schedule-read",
            "schedule-write",
            "rpm-read",
            "financial-read",
            "document-write",
            "document-read",
            "communication-write",
            "financial-write",
            "rpm-write"
        ],
        "org_uuid": 721192134,
        "org_name": "Jakes dev",
        "webhook_url": null,
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMzEiLCJqdGkiOiJhNDNiOTRiMzViZTljMDk1YmRkYWExYjE0NjM4MjcwNmY1ZmRkNzYxNDQ0ZmRlMWY1MjY2ZjI1Yzg4MzNkOTIxZmFjZjIzMTI1OGY3YjM3MiIsImlhdCI6MTYxMzU3OTQxNiwibmJmIjoxNjEzNTc5NDE2LCJleHAiOjI1NjAyNjQyMTYsInN1YiI6IiIsInNjb3BlcyI6W119.BFn7DTGzLKNEWblfAcZ6TCTKAscz1YjVuZLY0os3Cj5g0sByxT0vnT72a-sStalnUJHMat9HFfVEzHJKOlm8BHvwgiiuOL7z9adqHztF9JQWX_VsPo9Y9LLuOpj-0f15oYoO9jTFQZUlX52RT-d1B5GtqaLnyc_wRZ9NIgV3MU6xggQG_LrpZVUSwRFgKAWLUVocjqNpjAdAu0imMNyewe4u48Zt4KU5Oa1tiGUxJclKWqVbqwuDWVEQEDRyHfr96bFc3DVaIPDSCL2I8zXD95_rTqOJIc0jTgZdboQqx7xSuCA69DToq0RXKEHfTmkVnkepJYOdJ6mrSTpeio6A9Omux_0zZyH7qSSeBoMxaPKViNzdp3YtUnoRw94E7bQor4ICpk9W5ao0kw3vyyxLSc9laEjg_KA5ksdu0uvoWaa_sXjyVjGjM1lDHhgMFBNckGk8qYgr9vNQpcJ45pI3Z7nQgSCqtSt3q8dr9FlYvBFDwE42IEmjjnMlaYOZyVEFRawBMGAayQOB3jnUT05gV4oLCA6ndw7FL7LODa5StYtQAE0228gTgRfPuSvJG1JFWuP-SUPl-XzK6wfJLHl9TT1vT_-v2uxG5PbzB7i1lbYFX572NOvGdByFuAkbyogDMbB1tUkem--LgWaLx1S4N5WiHWWSDZ0YBc6ZCnf7Q5g",
        "installed_by": {
            "email": "bh+jakedev@docsink.com",
            "first_name": "jakey",
            "last_name": "lakey",
            "image": "https://docsinkconnectdev.s3.amazonaws.com/photo.png",
            "last_seen_datetime": "2021-02-09T19:21:11+00:00",
            "phone_number": null,
            "chat_status": null,
            "uuid": 1827524762,
            "teleheath_5_minute_check_in": false,
            "teleheath_5_minute_check_in_type": "email",
            "user_type": "Administrator"
        }
    }
}
Device order created
{
    "app_uuid": 314180500,
    "org_uuid": 568691045,
    "event_name": "device_order_created",
    "event_time": "2021-02-21T18:15:04+00:00",
    "payload": {
        "updated_at": "2021-02-21T18:14:57+00:00",
        "created_at": "2021-02-21T18:14:57+00:00",
        "uuid": 1285217310,
        "patient_uuid": 1680330017,
        "user_uuid": 324904135,
        "bot_uuid": null,
        "device_uuid": 451295675,
        "patient_rpm_program_uuid": 676991425
    }
}
Also available...
  • Appointment confirmed
  • Appointment cancelled
  • Task created
  • Task deleted
  • Task updated
  • Voice pager number created
  • Voice pager number deleted