Skip to content
Sursa Developers

Events · Sources and import

import.sync_completed

Import sync completed

A synchronization session of a custom source was closed (data.documents has the totals).

Object type
source
Delivered to
Endpoints with the admin role

Payload

Object: EventImportSyncCompleted

  • idstringrequired

    Event ID (evt_…), also sent as the webhook-id header. Use it to drop duplicate deliveries.

  • typestringrequired

    Allowed values: import.sync_completed

  • created_atstring (date-time)required

    When the change happened (UTC).

  • org_idintegerrequired
  • api_versionstringrequired

    Contract version of the data schema.

  • sequenceinteger

    Delivery sequence number within the endpoint (absent for a test event).

  • objectWebhookEventObjectrequired
  • payloadstringrequired

    thin means no data: read the object through the API.

    Allowed values: fullthin

  • dataobject
    Fields
    • sourceEventSourcerequired
    • syncEventSyncrequired
    • documentsobjectrequired

      Document totals of the session.

      Fields
      • addedinteger
      • updatedinteger
      • unchangedinteger
      • removedinteger
      • failedinteger
  • testbooleanrequired

    A test event sent by POST /v1/webhooks/{webhook_id}/test.

Example delivery

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "import.sync_completed",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "source",
    "id": "5"
  },
  "payload": "full",
  "data": {
    "source": {
      "id": 5,
      "name": "Help center",
      "kind": "custom",
      "collection_id": 3
    },
    "sync": {
      "run_id": 902,
      "status": "success",
      "stats": {
        "listed": 120,
        "added": 3,
        "updated": 5,
        "unchanged": 112,
        "removed": 0,
        "errors": 0
      }
    },
    "documents": {
      "added": 3,
      "updated": 5,
      "unchanged": 112,
      "removed": 0,
      "failed": 0
    }
  },
  "test": false
}

Receiving events

Each delivery is a POST request with this JSON body to your endpoint. Verify the webhook-signature header (Standard Webhooks) before you trust the body, answer with a 2xx status within a few seconds, and do the work afterwards. Deliveries to one endpoint keep the order of events; a failed delivery is retried with growing pauses.

New event types and new fields can appear at any time: skip the types and fields you do not know.

The same events are in the event feed for 30 days →