Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
Bodyapplication/jsonrequired
Optional list of field names to include in the webhook payload. If omitted or empty, the default payload for the event type is sent.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/webhook/{webhookId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/webhook/{webhookId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/webhook/{webhookId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"eventType": "string",
"extensions": {},
"fields": [
"string"
],
"isActive": true,
"webhookUrl": "string",
"description": "string"
}'Webhook replaced successfully
Timestamp when the webhook was created.
Example: "2025-01-01T00:00:00.000Z"
Optional list of field names to include in the webhook payload. If omitted or empty, the default payload for the event type is sent.
Timestamp when the webhook was last updated.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for the webhook.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "eventType": "string", "extensions": {}, "fields": [ "string" ], "isActive": true, "updatedAt": "2025-01-01T00:00:00.000Z", "webhookId": "123e4567-e89b-12d3-a456-426614174000", "webhookUrl": "string", "description": "string" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/webhook/{webhookId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/webhook/{webhookId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/webhook/{webhookId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'