Documentation

Learn how to build, publish, and launch your site with Adobe Experience Manager.

Resources

Create your site

Scheduled Publishing

With Edge Delivery Services, you can schedule snapshots and individual pages to publish at a future date and time. Add as many pages as needed to a snapshot, and they will all go live together when the scheduled time arrives.

This guide explains how to register your organization and site to enable automated snapshot scheduling.

Your site uses Document Authoring (DA)

Scheduling is built-in. Anyone with an administrator role can register your org and site directly in the Scheduling app: https://da.live/apps/scheduler

Your site uses other authoring

Follow the instructions below to set up scheduling with our scheduling service

Prerequisites

Before registering, you'll need:

1. Your organization name - The name of your AEM organization

2. Your site name - The name of your site within the organization

3. An AEM Admin API token - You need admin-level access to your org/site. Get your token to be able to register your org/site for scheduled publishing. Note: This token (in the Authorization: token … header) authenticates you, the human, doing the one-time registration. It's your signed-in session token and must carry the admin role.

4. An Admin API Key - An Admin API key for the scheduler service that has permissions to publish snapshots. Note: The value in the response is the actual API key. Store it securely as it will not be retrievable again through the API. This token (the apiKey field in the body) is a long-lived, stored credential the scheduler worker uses to publish content. It's created via the Admin config API and only needs the publish role.

Quick Start

Register Your Org/Site

Copy and run this command, replacing the placeholders with your actual values:

curl -X POST https://helix-snapshot-scheduler-prod.adobeaem.workers.dev/register \
  -H "Content-Type: application/json" \
  -H "Authorization: token YOUR_AEM_ADMIN_TOKEN" \
  -d '{
    "org": "your-org",
    "site": "your-site",
    "apiKey": "your-api-key"
  }'

Verify Registration

Check if your org/site is registered:

curl https://helix-snapshot-scheduler-prod.adobeaem.workers.dev/register/your-org/your-site \
  -H "Authorization: token YOUR_AEM_ADMIN_TOKEN"

Response:

{
  "registered": true
}

Next Steps

  1. If you are using Adobe’s DA (Document Authoring - da.live) with AEM Edge Delivery Services, create a snapshot like you normally would and schedule it for publishing
  2. If you are using other authoring tools with AEM Edge Delivery Services, you can use the Snapshot Admin tool to manage snapshots and schedule them for publishing.
  3. You can also schedule individual pages for publishing in DA using the same registration.
  4. You can also schedule individual pages for publishing in non-DA authoring systems using the sidekick plugin as shown below:

Sidekick plugin

Any Edge Delivery Services project can add the scheduler popover to its Sidekick by appending

this entry to /config/{org}/sites/{site}/sidekick.json under plugins:

{
  "id": "schedule-publish",
  "title": "Schedule Publish",
  "environments": ["edit", "preview"],
  "url": "https://tools.aem.live/tools/scheduler/schedule.html",
  "isPopover": true,
  "popoverRect": "width: 480px; height: 360px",
  "passReferrer": true,
  "passConfig": true
}

Troubleshooting

"Unauthorized" Error

Problem: You receive a 401 status code.

Solutions:

"Invalid body" Error

Problem: You receive a 400 status code with a message about invalid body.

Solutions:

Registration succeeded but can't schedule

Problem: Registration works but snapshot scheduling fails.

Solutions: