POST https://api.usecommune.comsubscriber.created Production. There is no separate sandbox host.

Subscriber created

Someone became a subscriber of the newsletter. Four paths land here: subscribing from inside the Commune app, finishing signup, accepting an invitation, and a CSV or ESP import.

Only the import path records where they came from. data.acquisition_source carries the provider there and is null on the other three, so null is the normal case for anybody who arrived through Commune itself rather than a sign that the origin was lost.

Reactivation counts. Unsubscribing does not delete a subscriber, so a returning reader comes back to subscribed rather than being recorded again. That still fires this topic, with data.resubscribed: true.

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

Someone became a subscriber, or an unsubscribed one came back.

  • string(uuid) Required
  • string Required
  • string Required
  • string(date-time) Required
  • string(uuid) | null Required
  • string | null Required
POST subscriber.created
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-onsubscribercreated

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.