Get Webhooks

Retrieves all registered webhooks. This endpoint allows partners to get a list of all webhooks that have been registered. Each webhook in the list includes details such as the unique identifier, event names that trigger the webhook, the endpoint URL, the signing key (if provided), the client ID, the protocol used, and timestamps for when the webhook was created and last updated. This information helps partners manage and audit their webhook configurations.

GET /notification/v1/connect/webhook/subscriptions

Get Webhooks

cURL

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

import requests

url = "https://api.eka.care/notification/v1/connect/webhook/subscriptions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.eka.care/notification/v1/connect/webhook/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eka.care/notification/v1/connect/webhook/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eka.care/notification/v1/connect/webhook/subscriptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.eka.care/notification/v1/connect/webhook/subscriptions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/notification/v1/connect/webhook/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "7",
      "event_names": [
        "appointment.created",
        "appointment.updated",
        "prescription.created",
        "prescription.updated",
        "receipt.created",
        "receipt.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"
}

{
  "error": {
    "message": "Unauthorized request",
    "code": "INVALID_REQUEST"
  }
}

{
  "error": {
    "message": "Internal Server Error",
    "code": "SERVER_ERROR"
  }
}

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[]

Show child attributes

msg · string

A message indicating the status of the response.

Example:

"success"