Skip to content
Get an API key
Reference

Status

1 endpoints in this family.

Is everything working

GET/api/v1/health

Returns what is wrong with the WhatsApp numbers of the client you act on, if anything: a number that has received nothing for a while, one that cannot send, one whose quality Meta rated red. Each finding names the channel and says how serious it is.

Poll this rather than guessing from failures.

Response

An overall status and the list of findings.

  • data.healthyboolean

    true when nothing is wrong.

  • data.alertsobject[]

    What is wrong, most serious first.

    Show fields
    • levelstring

      How serious.

      warningcritical

    • codestring

      A stable code.

      channel_silentchannel_without_credentialschannel_quality_red

    • channelIdstring

      The channel concerned.

    • messagestring

      What it is, in words.

curl https://nodium.io/api/v1/health \ -H "Authorization: Bearer $NODIUM_KEY"

Response

200 OK
{ "data": { "healthy": true, "alerts": [ { "level": "warning", "code": "channel_silent", "channelId": "…", "message": "…" } ] }}