Integrations

Get Crm Connection Status

Is this connection working right now.

Distinct from GET /connections/{id}: that describes the connection, this one actually reaches the provider and reports whether the credentials still answer.

get/integrations/crm/connections/{connection_id}/status

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/integrations/crm/connections/{connection_id}/status
  • Auth: HTTP bearer

Path parameters

connection_idstring required

The CRM connection to act through.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataCrmPayload required

One CRM record, or one provider response.

Open-shaped ON PURPOSE. These bodies carry whatever the provider returned, the field set differs between HubSpot, Salesforce, Pipedrive and SugarCRM, and it grows every time one of them ships something. Pinning it would drop whatever a provider reported that this contract had not caught up on - which on a CRM surface means silently hiding the customer's own data from them.

Changes

No recorded changes to this operation across all 3 revisions of this API.