Create webhook subscription (beta)

post

https://nexhealth.info/webhook_endpoints/{id}/webhook_subscriptions

🚧
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 request field version; changes request fields event, resource_type; adds response 422; adds response field data.version.

This endpoint creates a webhook subscription on the given webhook endpoint; the optional version param pins the subscription to a specific API version for payload delivery, defaulting to v3.1.0 when omitted, and returns 422 if the version is unknown or does not support the subscribed event.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Webhook Endpoint id

Query Params

subdomain

string

required

Used to scope the request to the specified institution. For the following resources we don't require a subdomain: LocationDataReadiness, Onboarding

Body Params

Create webhook subscription

resource_type

string

enum

required

The resource to subscribe to

event

string

enum

required

A valid event type to listen to for the defined resource

active

boolean

Defaults to true

version

string

Defaults to v3.1.0

API version to pin this subscription to. Defaults to the version this request is made against (v3.1.0) when omitted. Webhook payloads delivered to this subscription use that version's entity contract. v3.0.0 and v20240412 are two names for the same version — either value is accepted, and the subscription is recorded under the canonical name v20240412. Returns 422 for unknown versions and for versions that do not offer the subscribed event.

Headers

Nex-Api-Version

string

required

Defaults to v3.1.0

The NexHealth API version

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Entity

500Internal Server Error