Create webhook subscription

post

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

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: Onboarding

Body Params

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

Headers

Nex-Api-Version

string

required

Defaults to v20240412

The NexHealth API version

Responses

Language

Credentials

Header

Response

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

application/vnd.Nexhealth+json;version=2

201Successful