Elation Health Event Subscriptions API

The Event Subscriptions API from Elation Health — 8 operation(s) for event subscriptions.

Documentation GitHub OpenAPI

Business capability

Webhook & Event Subscription Management BC-4270.80

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/2.0/app/published_events/ List events published to my app · List Published Events #

Ask an LLM

“Which webhook events has Elation published to my app so far?”

“Can I page through my app's published events and sort them?”

Tell an agent

List the events published to my app.

Show {limit} of my app's published events ordered by {order_by}.

GET /api/2.0/app/published_events/{event_id}/ Get one event published to my app · Get a Published Event #

Ask an LLM

“What did a single event delivered to my app contain?”

“Can I look up one app published event to see its status code and target?”

Tell an agent

Get app published event {event_id}.

Show the delivery details of my app's event {event_id}.

PATCH /api/2.0/app/published_events/{event_id}/ Patch fields on an app published event · Partially Update App Published Event #

Ask an LLM

“Can I change just the error content on an event sent to my app?”

“Is there a way to partially update one of my app's published events?”

Tell an agent

Patch app event {event_id} to record error {error_content}.

Mark my app's event {event_id} processed on {processed_date}.

PUT /api/2.0/app/published_events/{event_id}/ Replace an app published event record · Update a Published Event #

Ask an LLM

“Can I overwrite an event published to my app, including its processed date?”

“What fields must I send to fully replace an app published event?”

Tell an agent

Replace app published event {event_id} with processed date {processed_date}.

Overwrite my app's event {event_id} setting status code {status_code} and processed date {processed_date}.

GET /api/2.0/app/subscriptions/ List my app's resource subscriptions · List Subscriptions #

Ask an LLM

“Which resources is my app currently subscribed to for updates?”

“Can I page through all of my app's webhook subscriptions?”

Tell an agent

List my app's subscriptions.

Show {limit} of my app subscriptions starting at offset {offset}.

POST /api/2.0/app/subscriptions/ Subscribe my app to resource updates · Subscribe to a resource updates #

Ask an LLM

“How do I get my app notified when Elation patients or appointments change?”

“What happens if my app subscribes to the same resource and target twice?”

Tell an agent

Subscribe my app to {resource} updates delivered to {target}.

Create an app subscription for {resource} sending to {target} signed with key {signing_pub_key}.

DELETE /api/2.0/app/subscriptions/{id}/ Delete one of my app's subscriptions · Delete a Subscription #

Ask an LLM

“How do I stop my app receiving updates for a resource?”

“Can I remove an app subscription I no longer need?”

Tell an agent destructive · confirm first

Delete app subscription {id}.

Unsubscribe my app by removing subscription {id}.

GET /api/2.0/app/subscriptions/{id}/ Get one of my app's subscriptions · Get a Subscription #

Ask an LLM

“Can I check which resource and target one of my app subscriptions points at?”

“Where do I see the details of a single app subscription?”

Tell an agent

Get app subscription {id}.

Show the target URL for my app subscription {id}.

GET /api/2.0/published_events/ List published webhook events · List Published Events #

Ask an LLM

“Which events have been published to my webhook subscriptions?”

“Can I sort the published events feed outside the app namespace?”

Tell an agent

List published events.

Show {limit} published events sorted by {order_by}.

GET /api/2.0/published_events/{event_id}/ Get one published webhook event · Get a Published Event #

Ask an LLM

“How can I inspect a single published event and the resource it carried?”

“What resource id did a particular published event refer to?”

Tell an agent

Get published event {event_id}.

Look up the resource behind published event {event_id}.

PATCH /api/2.0/published_events/{event_id}/ Patch fields on a published event · Partially Update Published Event #

Ask an LLM

“Can I update only the status code of a published event?”

“Is partial updating supported for published events?”

Tell an agent

Set the status code of published event {event_id} to {status_code}.

Patch published event {event_id} with error content {error_content}.

PUT /api/2.0/published_events/{event_id}/ Replace a published event record · Update a Published Event #

Ask an LLM

“Can I fully replace a published event with a new processed date?”

“Which field is required when overwriting a published event?”

Tell an agent

Fully overwrite published event {event_id}, marking it processed {processed_date}.

Overwrite published event {event_id} with event type {event_type} processed on {processed_date}.

GET /api/2.0/subscriptions/ List resource update subscriptions · List Subscriptions #

Ask an LLM

“What webhook subscriptions exist outside the app namespace?”

“Can I list subscriptions a page at a time?”

Tell an agent

List all subscriptions.

Show subscriptions ordered by {order_by}.

POST /api/2.0/subscriptions/ Subscribe to resource updates · Subscribe to a resource updates #

Ask an LLM

“How do I register a webhook subscription for a resource's updates?”

“Will I get a 409 if I subscribe to the same resource and target again?”

Tell an agent

Create a subscription to {resource} delivering to {target}.

Subscribe {target} to {resource} changes with properties {properties}.

DELETE /api/2.0/subscriptions/{id}/ Delete a resource update subscription · Delete a Subscription #

Ask an LLM

“How do I cancel a webhook subscription?”

“Can I delete a subscription so events stop arriving?”

Tell an agent destructive · confirm first

Delete subscription {id}.

Cancel subscription {id} so it stops sending events.

GET /api/2.0/subscriptions/{id}/ Get a resource update subscription · Get a Subscription #

Ask an LLM

“How do I view a single subscription and its signing key?”

“Can I see when a subscription was created?”

Tell an agent

Get subscription {id}.

Show the resource and target on subscription {id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/elation-health:elation-health-event-subscriptions-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    name: Elation Health
    url: https://www.elationhealth.com/
  description: Elation Health API v2.0
  title: Elation Health Event Subscriptions API
  version: 2.0.0
servers:
- description: Sandbox Server
  url: https://sandbox.elationemr.com
- description: Production Server
  url: https://api.app.elationemr.com
tags:
- name: Event Subscriptions
paths:
  /api/2.0/app/published_events/:
    get:
      description: Returns a list of published events
      operationId: app_published_events_list
      parameters:
      - description: Number of results to return per page.
        in: query
        name: limit
        required: false
        schema:
          type: integer
      - description: The initial index from which to return the results.
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: Which field to use when ordering the results.
        in: query
        name: order_by
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPublishedEventList'
          description: ''
      security:
      - oauth2: []
      summary: List Published Events
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
  /api/2.0/app/published_events/{event_id}/:
    get:
      operationId: app_published_events_retrieve
      parameters:
      - description: The ID of the event to retrieve
        in: path
        name: event_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishedEvent'
          description: ''
      security:
      - oauth2: []
      summary: Get a Published Event
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    patch:
      description: Update an existing app published event.
      operationId: app_published_events_partial_update
      parameters:
      - description: The ID of the event to retrieve
        in: path
        name: event_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedPublishedEvent'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishedEvent'
          description: ''
      security:
      - oauth2: []
      summary: Partially Update App Published Event
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    put:
      description: Replace an existing app published event.
      operationId: app_published_events_update
      parameters:
      - description: The ID of the event to retrieve
        in: path
        name: event_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishedEvent'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishedEvent'
          description: ''
      security:
      - oauth2: []
      summary: Update a Published Event
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
  /api/2.0/app/subscriptions/:
    get:
      operationId: app_subscriptions_list
      parameters:
      - description: Number of results to return per page.
        in: query
        name: limit
        required: false
        schema:
          type: integer
      - description: The initial index from which to return the results.
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: Which field to use when ordering the results.
        in: query
        name: order_by
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSubscriptionList'
          description: ''
      security:
      - oauth2: []
      summary: List Subscriptions
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    post:
      description: You can only subscribe to the same resource and the same target once. A status 409 will be returned if you attempt to send duplicate subscription.
      operationId: app_subscriptions_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: ''
      security:
      - oauth2: []
      summary: Subscribe to a resource updates
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
  /api/2.0/app/subscriptions/{id}/:
    delete:
      description: Delete an existing app subscription.
      operationId: app_subscriptions_destroy
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '204':
          description: No response body
      security:
      - oauth2: []
      summary: Delete a Subscription
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    get:
      operationId: app_subscriptions_retrieve
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: ''
      security:
      - oauth2: []
      summary: Get a Subscription
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
  /api/2.0/published_events/:
    get:
      description: Returns a list of published events
      operationId: published_events_list
      parameters:
      - description: Number of results to return per page.
        in: query
        name: limit
        required: false
        schema:
          type: integer
      - description: The initial index from which to return the results.
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: Which field to use when ordering the results.
        in: query
        name: order_by
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPublishedEventList'
          description: ''
      security:
      - oauth2: []
      summary: List Published Events
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
  /api/2.0/published_events/{event_id}/:
    get:
      operationId: published_events_retrieve
      parameters:
      - description: The ID of the event to retrieve
        in: path
        name: event_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishedEvent'
          description: ''
      security:
      - oauth2: []
      summary: Get a Published Event
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    patch:
      description: Update an existing published event.
      operationId: published_events_partial_update
      parameters:
      - description: The ID of the event to retrieve
        in: path
        name: event_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedPublishedEvent'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishedEvent'
          description: ''
      security:
      - oauth2: []
      summary: Partially Update Published Event
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    put:
      description: Replace an existing published event.
      operationId: published_events_update
      parameters:
      - description: The ID of the event to retrieve
        in: path
        name: event_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishedEvent'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishedEvent'
          description: ''
      security:
      - oauth2: []
      summary: Update a Published Event
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
  /api/2.0/subscriptions/:
    get:
      operationId: subscriptions_list
      parameters:
      - description: Number of results to return per page.
        in: query
        name: limit
        required: false
        schema:
          type: integer
      - description: The initial index from which to return the results.
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: Which field to use when ordering the results.
        in: query
        name: order_by
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSubscriptionList'
          description: ''
      security:
      - oauth2: []
      summary: List Subscriptions
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    post:
      description: You can only subscribe to the same resource and the same target once. A status 409 will be returned if you attempt to send duplicate subscription.
      operationId: subscriptions_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: ''
      security:
      - oauth2: []
      summary: Subscribe to a resource updates
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
  /api/2.0/subscriptions/{id}/:
    delete:
      description: Delete an existing subscription.
      operationId: subscriptions_destroy
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '204':
          description: No response body
      security:
      - oauth2: []
      summary: Delete a Subscription
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    get:
      operationId: subscriptions_retrieve
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: ''
      security:
      - oauth2: []
      summary: Get a Subscription
      tags:
      - Event Subscriptions
      x-el8-docs-category: Event Subscription API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
components:
  schemas:
    PatchedPublishedEvent:
      properties:
        error_content:
          type:
          - string
          - 'null'
        event_id:
          readOnly: true
          type: integer
        event_type:
          readOnly: true
          type: string
        id:
          readOnly: true
          type: integer
        processed_date:
          format: date-time
          type: string
        resource:
          readOnly: true
          type: string
        resource_id:
          readOnly: true
          type: integer
        status_code:
          maximum: 2147483647
          minimum: -2147483648
          type:
          - integer
          - 'null'
        target:
          readOnly: true
          type: string
      type: object
    Subscription:
      properties:
        created_date:
          format: date-time
          readOnly: true
          type: string
        deleted_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        id:
          readOnly: true
          type: integer
        properties:
          description: Properties specific to this subscription.
          oneOf:
          - {}
          - type: 'null'
        resource:
          description: The resource name.
          maxLength: 50
          type: string
        signing_pub_key:
          readOnly: true
          type: string
        target:
          description: Target URL where we would send the POST request on new events.
          format: uri
          type: string
      required:
      - resource
      - target
      type: object
    PublishedEvent:
      properties:
        error_content:
          type:
          - string
          - 'null'
        event_id:
          readOnly: true
          type: integer
        event_type:
          readOnly: true
          type: string
        id:
          readOnly: true
          type: integer
        processed_date:
          format: date-time
          type: string
        resource:
          readOnly: true
          type: string
        resource_id:
          readOnly: true
          type: integer
        status_code:
          maximum: 2147483647
          minimum: -2147483648
          type:
          - integer
          - 'null'
        target:
          readOnly: true
          type: string
      required:
      - processed_date
      type: object
    PaginatedSubscriptionList:
      properties:
        count:
          example: 123
          type: integer
        next:
          example: http://api.example.org/accounts/?offset=400&limit=100
          format: uri
          nullable: true
          type: string
        previous:
          example: http://api.example.org/accounts/?offset=200&limit=100
          format: uri
          nullable: true
          type: string
        results:
          items:
            $ref: '#/components/schemas/Subscription'
          type: array
      required:
      - results
      type: object
    PaginatedPublishedEventList:
      properties:
        count:
          example: 123
          type: integer
        next:
          example: http://api.example.org/accounts/?offset=400&limit=100
          format: uri
          nullable: true
          type: string
        previous:
          example: http://api.example.org/accounts/?offset=200&limit=100
          format: uri
          nullable: true
          type: string
        results:
          items:
            $ref: '#/components/schemas/PublishedEvent'
          type: array
      required:
      - results
      type: object
  securitySchemes:
    oauth2:
      flows:
        clientCredentials:
          scopes:
            act_as_user: Impersonate a provider via X-On-Behalf-Of (combinable with apiv2 or system scopes)
            apiv2: Full access to the API
            system/{resource_name}.read: Read access to a specific resource
            system/{resource_name}.write: Write access to a specific resource
          tokenUrl: /api/2.0/oauth2/token/
      type: oauth2
x-readme:
  proxy-enabled: true

Elation Health Event Subscriptions API

Operations 16

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification