API Reference

Create webhook subscription

post
https://nexhealth.info/webhook_endpoints//webhook_subscriptions

Creates a webhook subscription on the given webhook endpoint. The subscription is pinned to the API version used to create it (v20240412): webhook payloads delivered for this subscription use the v20240412 entity contract. To pin a subscription to a different version, create it via that version of this endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Webhook Endpoint id

Query Params
string
required

Used to scope the request to the specified institution. Required for institution-owned resources; must be omitted for the following resources (passing it returns 400): Onboarding

Body Params

Create webhook subscription

string
enum
required

The resource to subscribe to

string
enum
required

A valid event type to listen to for the defined resource

boolean
Defaults to true

Whether the subscription is active. Inactive subscriptions are kept but receive no webhook deliveries. Defaults to true.

Headers
string
required
Defaults to v20240412

The NexHealth API version

Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago