POST https://api.usecommune.comautomation.run.started Production. There is no separate sandbox host.

Automation run started

An event matched a live automation's trigger and Commune created a run for it. The run is one subscriber's passage through that automation.

It fires when the run row is written, which is before the first step executes, so the email a send_email step sends has not been sent yet when this arrives. Pair it with automation.run.completed and automation.run.exited to know how the run ended; exactly one of those two follows every run that ends.

Nothing is published for a run that was not created. An event the trigger filter declined, a subscriber the reentry rule has already sent through, and a run the loop guard refused all leave no row and so no message. A creator's second automation that never fires is a question for the dashboard, not a silence this topic reports.

data.subscriber_id is null when the run's trigger is not about a person, which is every topic except the subscriber.* and delivery.* ones. Such a run can branch on its event and wait, but it has nobody to email or tag.

actor names this run. See automation.run.completed for what the loop guard does with it.

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 event matched a live automation's trigger and Commune created a run.

  • string(uuid) Required
  • string Required
  • string Required
  • string(date-time) Required
  • string(uuid) | null Required
  • string | null Required
POST automation.run.started
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-onautomationrunstarted

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.