Sign in

postWebhookSync Connection Deleted

Payload

ClientIdSchema — unresolved $ref
ClientNamestring

Name of your client in Codat.

CompanyIdSchema — 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.

Example payload

{
  "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
  "ClientName": "Bank of Dave",
  "CompanyId": "8a210b68-6988-11ed-a1eb-0242ac120002",
  "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
  "RuleType": "Sync Connection Deleted",
  "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  "Message": "Sync connection for company 8a210b68-6988-11ed-a1eb-0242ac120002 deleted"
}

Response

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

Changes