Healthcheck
Health check should be the first directive to implement. Why?
You can trigger it by clicking a button and see feedback in real time.
This is quite handy when implementing: Authentication
Before implementing a directive implement the Directives processing loop.
Expected Payload:
JSON
{
"directives": [
{
"directive": "health_check",
"args": {},
"id": "030fe55d-abd9-4ad5-b8c9-690549d9abec"
}
]
}
Minimal Required response:
JSON
{
"results": [
{
"data": {
"healthy": true,
"internal_error": null,
"public_error": null,
},
"source_directive": "health_check",
"source_id": "030fe55d-abd9-4ad5-b8c9-690549d9abec",
"status": "ok"
}
]
}
Failing healthcheck:
JSON
{
"results": [
{
"data": {
"healthy": false,
"internal_error": "Something to help debugging.",
"public_error": "Your store is not working properly",
},
"source_directive": "health_check",
"source_id": "030fe55d-abd9-4ad5-b8c9-690549d9abec",
"status": "ok"
}
]
}
Richer Response:
JSON
{
"results": [
{
"data": {
"healthy": true,
"implemented_directives": [
"health_check",
"update_available_shipping_rates",
"update_tax_amounts",
"update_availability",
"complete_order",
"import_product_from_url"
],
"internal_error": null,
"name": "Katalys Shopify integration",
"public_error": null,
"version": "6edbd0b"
},
"source_directive": "health_check",
"source_id": "030fe55d-abd9-4ad5-b8c9-690549d9abec",
"status": "ok"
}
]
}