Get Webhooks - Eka Developer Platform APIs

Documentation

Authorization

Connect

Webhooks

HealthAI

Assessment
EkaScribe

General Tools

Medical Document Parsing

Doctor Tool

Actors
Instructions
Patient Registration API
Doctor and clinic API
Appointment API
Payments API
Prescription API
Notify
Webhooks

ABDM Connect

Create and Login
User Session
Patient Requests
Consents
Care Contexts
Providers
Profile
Scan & Share
Errors

Medical Knowledge-bases

Overview
Protocols
Medications

Medical Records

Create
Read
Update
Delete
Webhooks

User App

Notifications
Vital
Webhooks
Privacy

Release Notes

ABDM Connect

GET

notification

connect

webhook

subscriptions

curl --request GET \
  --url https://api.eka.care/notification/v1/connect/webhook/subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "7",
      "event_names": [
        "appointment.created",
        "appointment.updated",
        "prescription.created",
        "prescription.updated"
      ],
      "endpoint": "https://example.com/webhook",
      "signing_key": "supersecretkey",
      "client_id": "testing",
      "protocol": "https",
      "created_at": "2024-10-07T13:53:52Z",
      "updated_at": "2024-10-07T13:53:52Z",
      "created_by": "testing",
      "updated_by": "testing"
    }
  ],
  "msg": "success"
}

Authorizations

Authorization

string

header

required

The API requires a Bearer token in the Authorization header for authentication.

Response

200

application/json

List of webhooks.

data

object[]

data.id

string

The unique identifier for the webhook.

Example:

"7"

data.event_names

string[]

The type of events triggering the webhook, based on the event_names defined in the request.

Example:

[
  "appointment.created",
  "appointment.updated",
  "prescription.created",
  "prescription.updated"
]

data.endpoint

string

The URL where the webhook sends POST requests.

Example:

"https://example.com/webhook"

data.signing_key

string | null

A secret key used for securing the webhook. This key is optional and may be null if not required.

Example:

"supersecretkey"

data.client_id

string

The client-specific identifier for the webhook.

Example:

"testing"

data.protocol

string

The protocol used for the webhook communication, defined in the protocol field of the request.

Example:

"https"

data.created_at

string

The timestamp when the webhook was created.

Example:

"2024-10-07T13:53:52Z"

data.updated_at

string

The timestamp when the webhook was last updated.

Example:

"2024-10-07T13:53:52Z"

data.created_by

string

The identifier of the user or service that created the webhook.

Example:

"testing"

data.updated_by

string

The identifier of the user or service that last updated the webhook.

Example:

"testing"

msg

string

A message indicating the status of the response.

Example:

"success"

curl --request GET \
  --url https://api.eka.care/notification/v1/connect/webhook/subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "7",
      "event_names": [
        "appointment.created",
        "appointment.updated",
        "prescription.created",
        "prescription.updated"
      ],
      "endpoint": "https://example.com/webhook",
      "signing_key": "supersecretkey",
      "client_id": "testing",
      "protocol": "https",
      "created_at": "2024-10-07T13:53:52Z",
      "updated_at": "2024-10-07T13:53:52Z",
      "created_by": "testing",
      "updated_by": "testing"
    }
  ],
  "msg": "success"
}