Skip to content

Ping is a health check endpoint. It verifies the service is currently reachable. This also checks that an API token is still valid.

This is a simple endpoint call. It takes no parameters and returns no response body. A successful call returns only a 200 OK. That minimalism is intentional. It is typically hit frequently and automatically rather than as part of real business logic.

This endpoint is useful as:

  • an application startup check when an integration boots.
  • a periodic keep-alive in a monitoring dashboard,
  • a quick manual test after rotating an API key.

It shares the same error-handling shape as every other endpoint, such as response codes for 400, 401, 403, 429, or 500. These error response codes are diagnostically useful, too. For example, a response code of 401 indicates the API token is bad or expired.

See Also:
To ping a webhook endpoint, see POST /v2/webhooks/endpoints/{{webhookId}}/ping