Service Bulletins

How Service Bulletins Work

Service bulletins provide a means for communicating important updates or notices to users. These bulletins can be created, reviewed, and published using this feature. Below is an explanation of the lifecycle and the states a service bulletin can transition through.

You can manage service bulletins using both the Dashboard and the API.

State Transition

After creation, service bulletins move through a series of statuses. Each status defines what actions are possible and how the bulletin is handled. The lifecycle looks like this:

State

Description

Possible Actions

Draft

The service bulletin is open for editing and review.

Preview and Schedule Publish.

Publish Now.

Send Test Emails.

Preview and Schedule Publish

The bulletin is locked for editing and will be published at the end of the grace period.

Revert to Draft.

Publish Now.

Send Test Emails.

Published

The bulletin has been published, and notifications have been sent.

No further actions.

State Descriptions and Rules

Draft

  • Description:

    • The bulletin is open for editing and review.

  • Actions:

    • Preview and Schedule Publish: Locks the bulletin for editing and schedules publication after a 1-hour grace period.

    • Publish Now: Immediately publishes the bulletin and sends user notifications.

    • Send Test Email: Send a test email to review the service bulletin before publication.

Preview

  • Description:

    • The bulletin is locked for editing and scheduled for automatic publication.

  • Rules:

    • No edits or deletions are allowed.

  • Actions:

    • Revert to Draft: Cancels the scheduled publication and unlocks the bulletin for further edits.

    • Publish Now: Immediately publishes the bulletin and sends notifications.

    • end Test Email: Send a test email to review the service bulletin before publication.

Published

  • Description:

    • The bulletin has been published and notifications sent.

  • Rules:

    • The bulletin is locked; no further actions or edits are allowed.

  • Actions:

    • None.

Usage Example

Creating a New Bulletin

  1. Start by creating a bulletin in the Draft state.

  2. Edit and review the content.

Publishing a Bulletin

  • Use Publish with Preview to lock the bulletin and schedule it for publication after a 1-hour grace period.

  • Use Publish Now to immediately publish the bulletin.

Managing Preview State

  • If changes are required during the 1-hour grace period, use Revert to Draft to cancel the scheduled publication and unlock the bulletin.

  • If ready to publish immediately, use Publish Now.

Post-Publication

  • Once published, the bulletin is locked, and no further actions are available.

Last updated