{"templateId":"markdown","versions":[{"version":"v1","label":"v1","link":"/api-reference/v1/components/docs/ping_overview","default":true,"active":false,"folderId":"1b9c9f54"},{"version":"v2","label":"v2 (Beta)","link":"/api-reference/v2/components/docs/ping_overview","default":false,"active":true,"folderId":"1b9c9f54"}],"sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Flute Developer","siteUrl":"https://developer.flute.com","description":"Documentation and API reference for integrating Flute payment processing.","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ping is a health check endpoint."," ","It verifies the service is currently reachable."," ","This also checks that an API token is still valid."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint is useful as:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an application startup check when an integration boots."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a periodic keep-alive in a monitoring dashboard,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a quick manual test after rotating an API key."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"className":"api-seealso"},"children":["See Also:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","To ping a webhook endpoint, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-reference/v2/webhooks/flute-v2-post-webhooks-endpoints-endpointid-ping","style":{"textDecoration":"underline","fontWeight":"normal"}},"children":["POST /v2/webhooks/endpoints/{{webhookId}}/ping"]}]}]},"headings":[],"frontmatter":{"seo":{"title":""}},"lastModified":"2026-09-06T03:30:24.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference/v2/components/docs/ping_overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}