Codat · Schema

Account categories updated webhook

Webhook request body for the "Account categories updated" event.

Unified_API

Properties

Name Type Description
ClientId string Unique identifier for your client in Codat.
ClientName string Name of your client in Codat.
CompanyId object
DataConnectionId object
RuleId string Unique identifier for the rule.
RuleType string The type of rule.
AlertId string Unique identifier of the webhook event.
Message string A human-readable message about the webhook.
Data object
View JSON Schema on GitHub

JSON Schema

codat-accountcategoriesupdatedwebhook-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountCategoriesUpdatedWebhook",
  "title": "Account categories updated webhook",
  "description": "Webhook request body for the \"Account categories updated\" event.",
  "x-internal": true,
  "type": "object",
  "properties": {
    "ClientId": {
      "title": "Client ID",
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for your client in Codat."
    },
    "ClientName": {
      "type": "string",
      "description": "Name of your client in Codat."
    },
    "CompanyId": {
      "$ref": "#/components/parameters/companyId/schema"
    },
    "DataConnectionId": {
      "$ref": "#/components/parameters/connectionId/schema"
    },
    "RuleId": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the rule.",
      "deprecated": true
    },
    "RuleType": {
      "type": "string",
      "x-stoplight": {
        "id": "34d52a089f08a"
      },
      "description": "The type of rule."
    },
    "AlertId": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier of the webhook event."
    },
    "Message": {
      "type": "string",
      "description": "A human-readable message about the webhook."
    },
    "Data": {
      "$ref": "#/components/schemas/AccountCategoriesUpdatedWebhook/definitions/AccountCategoriesUpdatedWebhookData"
    }
  },
  "definitions": {
    "AccountCategoriesUpdatedWebhookData": {
      "type": "object",
      "title": "Account categories updated webhook data",
      "properties": {
        "modifiedDate": {
          "$ref": "#/components/schemas/SourceAccountV2/properties/feedStartDate",
          "description": "The date on which the company's account categories were last modified in Codat."
        }
      }
    }
  },
  "examples": [
    {
      "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": "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"
      }
    }
  ]
}