COcounselhealth
/v1/webhook

Update a webhook subscription

Update a webhook subscription by ID. Pass null to unset optional fields in the DB. Only the fields passed will be updated.

patch/v1/webhooks/{webhookId}/

Request

  • Base URL
    https://api.counselhealth.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

webhookIdstring required

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Optional idempotency key. Repeat requests with the same key and body return the original result.

Request body

namestring nullable
destinationstring starts_with
status'active' | 'inactive'

Example request

{
  "destination": "https://www.google.com"
}

Response

Default Response

idstring uuid required
namestring nullable required
destinationstring starts_with required
status'active' | 'inactive' required
created_atstring date-time required

datetime in ISO 8601 format

updated_atstring date-time required

datetime in ISO 8601 format

Example response

{
  "destination": "https://www.google.com",
  "created_at": "2030-01-01T00:00:00Z",
  "updated_at": "2030-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.