Sign in

Indicates a failure occurred during an expense sync. Used for Sync for Expenses only.

This event type is deprecated. Use the expenses.sync.unsuccessful to get notified when an expense sync completes unsuccessfully.

postWebhookSyncFailed

Payload

ClientIdstring uuid

Unique identifier for your client in Codat.

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.

DataSyncFailedWebhookData — unresolved $ref

Example payload

{
  "ClientId": "30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e",
  "ClientName": "Expense Sync",
  "CompanyId": "1f9559e7-8368-48c9-bdf4-f158e16b8b85",
  "RuleId": "289c80dc-2aee-4b71-afff-9acd8d051080",
  "RuleType": "Sync Failed",
  "AlertId": "72c1103b-7f17-4a3a-8db5-67c2d360a516",
  "Message": "Sync 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense has failed at step Pushing.",
  "Data": {
    "syncId": "3bead2a1-1b3d-4d90-8077-cddc5ca68b01",
    "syncType": "Expense",
    "FailureStage": "Pushing"
  }
}

Response

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

Changes