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

Subscriber joined a form

Somebody signed up through one of the newsletter's signup forms and is on the list. data.form_id and data.form_name say which form, and data.page_url the page it was on, as the reader's browser reported it.

Two paths land here, and data.new_subscriber tells them apart.

A new signup (new_subscriber: true). Every form is double opt-in, so somebody who was not on the list gets a confirmation email and this fires only once they click it. In the same transaction they become a subscriber, which publishes subscriber.created as well (carrying the same form_id), and the form's tags are applied, which publishes one subscriber.tagged per tag. Somebody who had unsubscribed and signs up again is this case too: they had to confirm, and subscriber.created arrives with resubscribed: true.

Somebody already on the list (new_subscriber: false). They join the form straight away with no confirmation email, the form's tags are applied, and this is the only subscriber event published, because their subscription did not change. This is what lets a form that hands over a download reach existing subscribers too.

Fires every time somebody signs up through a form, including a second signup through the same form. An automation that should run once per person keeps re-entry off.

data.actor is always null: the reader did this on a page of the creator's, and no credential was involved.

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

Somebody signed up through one of the newsletter's forms and is on the list.

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

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.