cs-icon.svg

Job-Based Publish/Unpublish Webhooks

Job-based webhook events trigger when bulk publish/unpublish operations complete. These are typically used when you need a single webhook notification summarizing the outcome of a job, rather than one webhook notification per entry or asset.

Event Types

Event NameDescription
jobs.environments.publish.completedTriggered when a bulk publish job completes in any environment
jobs.environments.unpublish.completedTriggered when a bulk unpublish job completes in any environment
jobs.environments.{environment_name}.publish.completedTriggered when a bulk publish job completes in a specific environment
jobs.environments.{environment_name}.unpublish.completedTriggered when a bulk unpublish job completes in a specific environment

Entry or Asset-Based vs. Job-Based Webhooks

Differentiating FactorEntry-/Asset-based WebhooksJob-based Webhooks
Trigger ConditionPer entry/asset actionPer job completion
Bulk Publish/Unpublish of N ItemsWebhook triggered N timesWebhook triggered once
Single Item Publish/UnpublishWebhook triggered onceWebhook triggered once
Payload ContentFull entry/asset detailsSummary (job ID, status counts)
Use CasesPer-item trackingSummary-based cache updates

Using Job-based Webhooks to Retrieve Entries/Assets

Job-based webhooks are especially useful for post-processing bulk operations. You can use the job_id from the webhook payload to retrieve the list of items involved.

Follow the steps below to retrieve entry/asset information via job_id:

  1. In the payload for job-based webhooks, you receive a job_id similar to the following:
    {
      ...
      "job_id": "00906443-2ba3-420e-a3bd-2b6b4cd7c5745"
    }
  2. Use this job_id in the Get job items status API request to retrieve a list of entries and assets that were published or unpublished as part of the job.
  3. Use the Get a single entry or Get a single asset APIs to further fetch the complete details.

These steps help you retrieve full metadata and content for assets/entries within a job-based webhook.

Was this article helpful?
^