Bulk Client Import

Entity name: bulk_import

Event type: done

📘

This webhook should be used only with applications that utilize a client import session. It will be triggered upon import completion of each bulk of clients provided by the app.

Subscribing to this webhook requires an app token of the app initiating the bulk import session.

bulk_import/done subscribe example

curl --location --request POST '/platform/v1/webhook/subscribe' \
--header 'Authorization: "Bearer API_TOKEN"'\
--header 'Content-Type: application/json' \
--data-raw '{
"event": "bulk_import/done",
"target_url": "URL"
}'

Event payload

 {
      "data": {
        "session_id": "0a35841d-d6af-40ca-82b5-0ba1dcbf4970",
        "processed_entity": "clients",
        "import_done": false,
        "page": 2,
        "clients_import_status": {
          "created": {
            "count": 2,
            "external_ids": [
              435647,
              665674
            ]
          },
          "failed": {
            "external_ids": [],
            "count": 0
          },
          "updated": {
            "count": 0,
            "external_ids": []
          },
          "skipped": {
            "count": 0,
            "external_ids": []
          }
        }
      },
      "entity_name": "bulk_import",
      "event_type": "done"
    }