Edit webhook subscription

patch

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

Updates a webhook subscription. The subdomain parameter is required for request validation even when the subscription is not scoped to an institution (e.g. Onboarding); pass the subdomain of any institution your API user has access to.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Webhook Endpoint id

subscription_id

int32

required

Webhook Subscription id

Query Params

subdomain

string

required

Used to scope the request to the specified institution

Body Params

Edit webhook subscription

new_endpoint_id

int32

Id of another webhook endpoint owned by the same API user to move this subscription to. Future webhook deliveries go to the new endpoint. Returns 404 if the id does not belong to one of your webhook endpoints. After a successful move, subsequent requests for the subscription must use the new endpoint id in the URL path; requests using the old endpoint id return 404.

active

boolean

Set to false to pause webhook deliveries for this subscription, or true to resume them. Omitting the param leaves the current value unchanged.

Headers

Nex-Api-Version

string

required

Defaults to v3.0.0

The NexHealth API version

Responses

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error