Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cloudinary Notifications and Webhooks

Cloudinary fires HTTP webhook notifications for upload completion, eager transformation completion, AI moderation outcomes, asset deletion, and backup events. Notifications include signatures for verification and can target multiple endpoints per product environment.

Cloudinary Notifications and Webhooks is one of 9 APIs that Cloudinary publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Events, Notifications, and Webhooks. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 1 operation across 1 channel, and defines 36 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through a single server, {notificationUrl} (https).

1 operations 1 channels 36 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Server
{notificationUrl} (https)
Resource Areas
1

Channels & Operations 1

Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.

Channels 1
PUB
/cloudinary/notifications
Receive a Cloudinary notification
receiveCloudinaryNotification body

Messages & Schemas 36

The contract defines 36 schemas that model the data carried by its messages. The most detailed are UploadPayload (30 properties), ProofStatusChangedPayload (13 properties), RenamePayload (12 properties), EagerPayload (10 properties). Each schema is shown below with its type and property counts.

Upload
message
Fired when an asset upload completes.
Eager
message
Fired when one or more eager transformations finish processing.
Rename
message
Fired when an asset's public ID changes.
Delete
message
Fired when one or more assets are deleted.
Move
message
Fired when assets move between folders.
CreateFolder
message
Fired when a new asset folder is created.
DeleteFolder
message
Fired when an asset folder is deleted.
MoveOrRenameAssetFolder
message
Fired when an asset folder path is moved or renamed.
ResourceTagsChanged
message
Fired when tags are added to or removed from one or more resources.
ResourceContextChanged
message
Fired when contextual metadata on a resource is added, updated, or removed.
ResourceMetadataChanged
message
Fired when structured metadata on a resource is modified.
ResourceDisplayNameChanged
message
Fired when an asset's display name is modified.
AccessControlChanged
message
Fired when an asset's access control settings change.
RelatedAssets
message
Fired when related-asset relationships are added or removed.
Multi
message
Fired when a multi (animated GIF / sprite / PDF) generation completes.
Explode
message
Fired when a multi-page asset explosion (e.g. PDF) completes.
ProofStatusChanged
message
Fired when a creative approval proof status changes.
NotificationContext
object
Common contextual envelope sent with every notification. Identifies when the underlying event occurred and what triggered it.
2 properties
AssetReference
object
Reference to an asset by its identifiers.
4 properties
UploadPayload
object
30 properties 1 required
EagerPayload
object
10 properties 1 required
RenamePayload
object
12 properties 1 required
DeletePayload
object
4 properties 1 required
MovePayload
object
5 properties 1 required
CreateFolderPayload
object
6 properties 1 required
DeleteFolderPayload
object
6 properties 1 required
MoveOrRenameAssetFolderPayload
object
6 properties 1 required
ResourceTagsChangedPayload
object
5 properties 1 required
ResourceContextChangedPayload
object
5 properties 1 required
ResourceMetadataChangedPayload
object
5 properties 1 required
ResourceDisplayNameChangedPayload
object
7 properties 1 required
AccessControlChangedPayload
object
5 properties 1 required
RelatedAssetsPayload
object
7 properties 1 required
MultiPayload
object
8 properties 1 required
ExplodePayload
object
7 properties 1 required
ProofStatusChangedPayload
object
13 properties 1 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

cloudinary-notifications-asyncapi.yml Raw ↑

Other APIs Cloudinary publishes across the network.

Cloudinary Admin API
Cloudinary Search API
Cloudinary Provisioning API
Cloudinary Permissions API
Cloudinary Transformation URL API
Cloudinary Backup API
Cloudinary Transformation API
Cloudinary Upload API