Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Fully replaces an existing Webhook Event. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

webhookEventIdstringrequired

Webhook Event unique identifier (UUID)

Bodyapplication/jsonrequired
descriptionstringrequired

Human-readable description of the webhook event.

eventTypestringrequired

Type of event that will trigger the webhook.

Enum"appointment.created""appointment.updated""product.created""product.updated""user.created""user.updated""consult.created""consult.updated""therapeutic.created""therapeutic.updated"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isEnabledbooleanrequired

Whether this webhook event is currently enabled.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/webhook-event/{webhookEventId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "eventType": "appointment.created",
    "extensions": {},
    "isEnabled": true
  }'

Responses

Webhook Event replaced successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this webhook event configuration was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstringrequired

Human-readable description of the webhook event.

eventTypestringrequired

Type of event that will trigger the webhook.

Enum"appointment.created""appointment.updated""product.created""product.updated""user.created""user.updated""consult.created""consult.updated""therapeutic.created""therapeutic.updated"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isEnabledbooleanrequired

Whether this webhook event is currently enabled.

updatedAtstring(date-time)required

Timestamp when this webhook event configuration was last updated.

Example: "2025-01-01T00:00:00.000Z"
webhookEventIdstringrequired

Stable, opaque identifier for this webhook event configuration.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "eventType": "appointment.created", "extensions": {}, "isEnabled": true, "updatedAt": "2025-01-01T00:00:00.000Z", "webhookEventId": "123e4567-e89b-12d3-a456-426614174000" }

Request

Permanently deletes a Webhook Event record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

webhookEventIdstringrequired

Webhook Event unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/webhook-event/{webhookEventId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhook Event deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations