Person Import API Finished

This webhook is triggered when a person import via API is finished.

_eventType · string · required

The type of event. For this webhook, it is always person_import.api.finished.

importId · string · required

Unique identifier of the import.

status · string · required

Status of the import. Possible values are NOT_STARTED, UPLOADING, ERROR, and COMPLETED.

updatedAt · string · required

Timestamp the import finished.

failedRecords · array · required

Array of failed records. Each record contains either a personId or an email field. Can be null if there are no failed records.

Example Payload:

{
  "_eventType": "person_import.api.finished",
  "importId": "test_cm1uwhduy001vle4gr4soyqkq",
  "status": "COMPLETED",
  "updatedAt": "2024-09-01T00:00:00Z",
  "failedRecords": [
    {
      "personId": "test_cm1uwhduy001vle4gr4soyqkq"
    },
    {
      "email": "[e-mail]"
    }
  ]
}