# Import finished **POST import.completed** A bulk ingest run finished. `data.kind` says which of the three it was. `articles`: an import a creator started against their connected provider finished the batch they picked. `imported_count` is the number that actually landed. `subscribers`: a pull of every active contact from the connected provider finished. An uploaded CSV ends the same way, with `source: csv`. `migration`: the newsletter was flipped onto native sending. That is the destructive step of the move off a provider, and after it Commune sends the newsletter itself. What this topic is for is invalidation. Every one of these runs writes many rows at once, and none of them fans out into per-row events: an import does not emit one `article.published` or one `subscriber.created` per row it touched, because a provider migration of fifty thousand contacts would bury a consumer. This is the single event that says the shape of the newsletter just changed underneath you, so refetch. Only a run that reached its end publishes here. Both import paths stream their progress and swallow per-row failures, so a partial run still finishes and still fires, with a lower `imported_count` and no separate count of what it dropped. A run whose connection died mid-stream produces nothing at all, and there is no `import.failed` to pair with this. There is no run identifier on this payload and no `/imports/{id}` to look one up in. An import is a streamed request that ends by writing its rows and closing the response: nothing persists a job row, so an id here would reference something no consumer could ever fetch. What identifies a run is the newsletter, the kind and the source, and the only thing to do with one is refetch. Every one of these is idempotent and safe to re-run, so a consumer should expect to see the same import kind more than once for one newsletter. Delivered as a single HTTPS POST to the consumer's registered endpoint, with the message as the JSON request body. Respond 2xx to acknowledge. Anything else, or a timeout, is retried with backoff, so acknowledge fast and do the work afterwards. ## Servers - Production. There is no separate sandbox host. : https://api.usecommune.com (Production. There is no separate sandbox host. ) ## Authentication methods - Webhook signature ## Parameters ### Headers - **Commune-Version** (string) API version the payload conforms to. Same value as `api_version` in the envelope. - **Commune-Event-Id** (string(uuid)) Same value as `id` in the envelope. The dedupe key. - **Commune-Event-Type** (string) Same value as `type` in the envelope. The topic name. - **Commune-Signature** (string) HMAC over the raw request body. Verify before parsing. - **Commune-Timestamp** (string) Unix seconds the signature was produced at. Reject anything outside your tolerance window. - **Commune-Delivery-Attempt** (integer) 1 on the first attempt, incremented on each retry. Informational only. A consumer must be idempotent regardless of its value. ### Body: application/json (object) - **id** (string(uuid)) Unique id for this event. Stable across redeliveries, so it is the dedupe key. It is the primary key of the row the publisher wrote, which means it is assigned when the state change is recorded, not when the message is dispatched. - **type** (string) The topic name, identical to the channel address. Route on this. - **api_version** (string) The `Commune-Version` value this payload conforms to. Present on the message itself, not only on the request header, so an event persisted to a consumer's own store stays self-describing. - **occurred_at** (string(date-time)) RFC 3339 timestamp of the state change, not of the delivery attempt. Use it to order events, since delivery order is not guaranteed. - **newsletter_id** (string(uuid) | null) The newsletter the change belongs to. This is the tenant boundary: a consumer only ever receives events for newsletters its credential can read. Null only for events that are genuinely not newsletter-scoped, which none of the 21 topics currently are. - **actor** (object | null) Who caused the change. ALWAYS `null` today and consumers must treat it that way: the public API is currently read-only, so nothing that reaches this catalog was triggered through it, and Commune does not backfill an actor for changes made in the product UI or by a cron. The field exists now so that populating it, once writes exist, is an additive change rather than a new envelope version. - **idempotency_key** (string | null) ALWAYS `null` today. Once the public API accepts writes this carries the `Idempotency-Key` header of the write that caused the change, so a consumer can tie an event back to its own request and collapse the duplicates a retried write would otherwise produce. Null stays a legitimate value even then: a change made in the product UI or by a cron has no originating request to key on. - **data** (object) Event-specific body. Narrowed by each concrete event schema below. ## Responses ### 200 The consumer accepted the delivery. Any 2xx acknowledges the message and it is not sent again. ### 4XX The consumer rejected the delivery. Handled exactly like a 5xx: the message is retried with backoff, because a rejection cannot be told apart from a consumer that is briefly misconfigured. ### 5XX The consumer failed to handle the delivery. Retried with backoff. A timeout is the same case and is retried too. [Powered by Bump.sh](https://bump.sh)