POST https://api.usecommune.comimport.completed Production. There is no separate sandbox host.

Import finished

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's esp became commune. That is the destructive step of the move off a provider, and after it Commune sends the newsletter itself.

This topic is an invalidation signal. An import writes many records at once and fans out into no per-record events: it does not emit one article.published or one subscriber.created for each. This is the single message that says a newsletter changed underneath you, so refetch on it.

Only a run that reached its end publishes here. A partial run still finishes and still fires, with a lower imported_count and no count of what it dropped. A run whose connection died mid-stream produces nothing, and there is no import.failed to pair with this.

There is no run identifier on this payload and no operation to look one up in. A run is identified by the newsletter, the kind and the source, and the thing to do with one is refetch.

Imports are idempotent and safe to re-run, so expect to see the same 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.

Request Headers

  • string Required
  • string(uuid) Required
  • string Required
  • string Required
  • string(date-time) Required
  • integer

Body

An article, subscriber or migration run finished.

  • string(uuid) Required
  • string Required
  • string Required
  • string(date-time) Required
  • string(uuid) | null Required
  • string | null Required
POST import.completed
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-onimportcompleted

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.