NEnexhealth
Webhook Subscriptions

Edit webhook subscription (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds response field data.version.

This endpoint updates a webhook subscription; use active to pause or resume deliveries, or new_endpoint_id to move the subscription to a different endpoint. The subdomain parameter is required for request validation even when the subscription is not scoped to an institution.

patch/webhook_endpoints/{id}/webhook_subscriptions/{subscription_id}

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/webhook_endpoints/{id}/webhook_subscriptions/{subscription_id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Webhook Endpoint ID

subscription_idinteger required

Webhook Subscription ID

Query parameters

subdomainstring required

Used to scope the request to the specified institution

Headers

Nex-Api-Versionstring required

The NexHealth API version

Request body

new_endpoint_idinteger

New Endpoint ID

activeboolean

Example request

{
  "new_endpoint_id": 1,
  "active": true
}

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": 1,
    "webhook_endpoint_id": 1,
    "institution_id": 1,
    "resource_type": "Appointment",
    "event": "appointment_insertion",
    "active": true,
    "created_at": "2020-06-05T20:16:57.007Z",
    "updated_at": "2020-06-05T20:16:57.007Z",
    "version": "v3.1.0"
  },
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.