Sign in

postWebhookAccount categories updated

Payload

CompanyIdSchema — unresolved $ref
ClientIdstring uuid

Unique identifier for your client in Codat.

ClientNamestring

Name of your client in Codat.

DataConnectionIdSchema — unresolved $ref
RuleIdstring uuid

Unique identifier for the rule.

Typestring

The type of rule.

AlertIdstring uuid

Unique identifier of the webhook event.

Messagestring

A human readable message about the webhook.

Example payload

{
  "companyId": "f1c35bdc-1546-41b9-baf4-3f31135af968",
  "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  "clientName": "Peach Inc.",
  "dataConnectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
  "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
  "type": "Account Categories Updated",
  "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  "message": "Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.",
  "data": {
    "modifiedDate": "2019-08-24T14:15:22Z"
  }
}

Response

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

Changes