Create webhook subscription

post

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Where each parameter goes
subdomain goes in the query string. Sent in the JSON body instead, the call returns 403. resource_type and event go in the body and must match the names in the table on Webhook Subscriptions exactly, including case: Appointment, not appointment. A wrong value returns 400 Invalid value for parameter resource_type or Invalid value for parameter event.

Path Params

int32

required

Webhook Endpoint id

Query Params

subdomain

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

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

Headers

Nex-Api-Version

string

required

Defaults to v3.0.0

The NexHealth API version

Responses

Where each parameter goes

201Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error