> ## Documentation Index
> Fetch the complete documentation index at: https://ekacare-fix-ts-sdk-github-npm-links.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.




## OpenAPI

````yaml get /notification/v1/connect/webhook/subscriptions
openapi: 3.1.0
info:
  title: Webhook Service for the Clients
  description: >
    The Webhook Service allows clients to register webhooks that are triggered
    based on specific events. Each webhook is associated with a business_id,
    client_id, endpoint, and scopes. The scopes defines the type of events that
    will trigger the webhook.
  version: 1.0.0
servers:
  - url: https://api.eka.care
security: []
paths:
  /notification/v1/connect/webhook/subscriptions:
    get:
      tags:
        - Webhooks
      summary: Get Webhooks
      description: >
        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.
      responses:
        '200':
          description: List of webhooks.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookResponse'
                  msg:
                    type: string
                    description: A message indicating the status of the response.
                    example: success
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Unauthorized request
                      code:
                        type: string
                        example: INVALID_REQUEST
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Internal Server Error
                      code:
                        type: string
                        example: SERVER_ERROR
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the webhook.
          example: '7'
        event_names:
          type: array
          items:
            type: string
          description: >
            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
            - receipt.created
            - receipt.updated
        endpoint:
          type: string
          description: The URL where the webhook sends POST requests.
          example: https://example.com/webhook
        signing_key:
          type: string
          description: >
            A secret key used for securing the webhook. This key is optional and
            may be `null` if not required.
          nullable: true
          example: supersecretkey
        client_id:
          type: string
          description: The client-specific identifier for the webhook.
          example: testing
        protocol:
          type: string
          description: >
            The protocol used for the webhook communication, defined in the
            `protocol` field of the request.
          example: https
        created_at:
          type: string
          format: date-time
          description: The timestamp when the webhook was created.
          example: '2024-10-07T13:53:52Z'
        updated_at:
          type: string
          format: date-time
          description: The timestamp when the webhook was last updated.
          example: '2024-10-07T13:53:52Z'
        created_by:
          type: string
          description: The identifier of the user or service that created the webhook.
          example: testing
        updated_by:
          type: string
          description: The identifier of the user or service that last updated the webhook.
          example: testing
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The API requires a Bearer token in the Authorization header for
        authentication.

````