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 Name | Description |
| jobs.environments.publish.completed | Triggered when a bulk publish job completes in any environment |
| jobs.environments.unpublish.completed | Triggered when a bulk unpublish job completes in any environment |
| jobs.environments.{environment_name}.publish.completed | Triggered when a bulk publish job completes in a specific environment |
| jobs.environments.{environment_name}.unpublish.completed | Triggered when a bulk unpublish job completes in a specific environment |
Entry or Asset-Based vs. Job-Based Webhooks
| Differentiating Factor | Entry-/Asset-based Webhooks | Job-based Webhooks |
| Trigger Condition | Per entry/asset action | Per job completion |
| Bulk Publish/Unpublish of N Items | Webhook triggered N times | Webhook triggered once |
| Single Item Publish/Unpublish | Webhook triggered once | Webhook triggered once |
| Payload Content | Full entry/asset details | Summary (job ID, status counts) |
| Use Cases | Per-item tracking | Summary-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:
- In the payload for job-based webhooks, you receive a job_id similar to the following:
{ ... "job_id": "00906443-2ba3-420e-a3bd-2b6b4cd7c5745" } - 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.
- 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.
More articles in "Work with Webhooks"
Webhook Retry Policy
Learn more
About Webhooks
Learn more
Create a Webhook
Learn more
Edit a Webhook
Learn more
Enable or Disable a Webhook
Learn more
Delete a Webhook
Learn more
Import a Webhook
Learn more
Export a Webhook
Learn more
Webhook Events
Learn more
Secure Your Webhooks
Learn more
Webhook Circuit Breaker
Learn more
Send Concise Webhook Payload
Learn more
View Webhook Logs
Learn more
Webhook Data Format
Learn more
Limitations of Webhooks
Learn more
Webhook Integrations
Learn more
Webhooks FAQs
Learn more
