Sign in

Triggered anytime a data connection's status changes.

postWebhookCompany data connection status changed

Payload

ClientIdstring uuid

Unique identifier for your client in Codat.

ClientNameClientName — unresolved $ref
CompanyIdSchema — unresolved $ref
DataConnectionIdSchema — unresolved $ref
RuleIdRuleId — unresolved $ref
RuleTypeRuleType — unresolved $ref
AlertIdAlertId — unresolved $ref
MessageMessage — unresolved $ref
DataConnectionStatusChangedWebhookData — unresolved $ref

Example payload

{
  "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
  "ClientName": "Bank of Dave",
  "CompanyId": "8a210b68-6988-11ed-a1eb-0242ac120002",
  "DataConnectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
  "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
  "RuleType": "DataConnectionStatusChanged",
  "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  "Message": "Data connection for SandBox status changed from PendingAuth to Linked",
  "Data": {
    "dataConnectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    "newStatus": "Linked",
    "oldStatus": "PendingAuth",
    "platformKey": "gbol"
  }
}

Response

Return a 200 status to indicate that the webhook was received successfully.

Changes