Sign in

Triggered when a data synchronization is completed; a notification will be generated for each dataType as the sync completes.

postWebhookData sync completed

Payload

ClientIdstring uuid

Unique identifier for your client in Codat.

ClientNamestring

Name of your client in Codat.

CompanyIdSchema — unresolved $ref
DataConnectionIdSchema — unresolved $ref
RuleIdstring uuid

Unique identifier for the rule.

RuleTypestring

The type of rule.

AlertIdstring uuid

Unique identifier of the webhook event.

Messagestring

A human-readable message about the webhook.

DataDataSyncCompletedWebhookData — 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": "Data sync completed",
  "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  "Message": "Data sync of type creditNotes completed for company 7626befb-0c7d-49a4-9366-bc4c81b4e4b7",
  "Data": {
    "dataType": "creditNotes",
    "datasetId": "1541a5ee-0d84-4b6e-a7f7-c07c1f216333"
  }
}

Response

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

Changes