POST/v1/integrations/installations/{id}/health

Run the health check

Checks the dedicated key and sends a test event to the writeback endpoint; sets the status to ACTIVE or ERROR.

Scope integrations.manage

Path parameters

idstringrequired

Returns

14 fields of the 200 answer

idstringrequired

appKeystringrequired

namestringrequired

configobjectrequired

5 fields

instanceUrlstringrequired

writebackMethodenumrequired

NONECONNECTED_APPSITE_GUEST

writebackUrlstring

clientIdstring

mirrorAllItemsbooleanrequired

hasCredentialsbooleanrequired

statusenumrequired

PENDINGACTIVEERRORDISABLED

lastErrorstring or nullrequired

apiKeyIdstring or nullrequired

webhookEndpointIdstring or nullrequired

lastActivityAtdate-time or nullrequired

healthCheckedAtdate-time or nullrequired

createdAtdate-timerequired

updatedAtdate-timerequired

checksarray of objectsrequired

3 fields

checkenumrequired

api_keywriteback

okbooleanrequired

detailstring or nullrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.integrations.health('obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

{ "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "appKey": "Example", "name": "Welcome card", "config": { "instanceUrl": "https://example.com/r/Fq3ZtR8w", "writebackMethod": "NONE", "writebackUrl": "https://example.com/r/Fq3ZtR8w", "clientId": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "mirrorAllItems": false }, "hasCredentials": false, "status": "ACTIVE", "lastError": "Example", "apiKeyId": "key_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "webhookEndpointId": "wh_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "lastActivityAt": "2026-10-16T09:14:02.000Z", "healthCheckedAt": "2026-10-16T09:14:02.000Z", "createdAt": "2026-10-16T09:14:02.000Z", "updatedAt": "2026-10-16T09:14:02.000Z", "checks": [ { "check": "api_key", "ok": true, "detail": "The request body is invalid" } ] }