Skip to navigation
EventsEvent types

sync.canceled

Fires when a Model Sync execution is canceled. The execution also fires sync.completed with a status of canceled.

Payload fields

FieldTypeAlways presentDescription
organization_idstring (UUID)YesOrganization ID
sync_namestringYesName of the Model Sync
sync_idstring (UUID)YesModel Sync ID
execution_idstring (UUID)YesExecution ID
target_connection_idstring (UUID)YesDestination connection ID
statusstringYesStatus of the execution

Example

This example shows a webhook delivery, with the fields above in event. See the events overview for the delivery format.

{
  "id": "7d510db5-7d11-5d82-bd9e-a287594e2f2b",
  "created_at": "2024-01-01T02:00:00Z",
  "type": "sync.canceled",
  "event": {
    "organization_id": "be80a27e-0e80-4dcb-bee9-1666f02eeb83",
    "sync_name": "Salesforce contacts",
    "sync_id": "0b155265-c537-44c9-9359-a3ceb468a4da",
    "execution_id": "0ecd09c1-b901-4d27-9053-f0367c427254",
    "target_connection_id": "7c67e0b3-9759-44eb-b96c-2a7042b583f0",
    "status": "canceled"
  }
}