Cloud Recording API callback service

Agora Cloud Recording can notify your server when recording events occur. After you enable callbacks, Agora sends event payloads to your webhook through its notification service.

How callbacks work

1. Your application enables the callback service for Cloud Recording.
2. A recording event occurs, such as start, stop, upload progress, or a web page recording status change.
3. Agora sends an HTTPS callback to your server.
4. Your server verifies the signature and processes the payload.

Payload basics

The callback request body contains a top-level JSON object. The payload object includes common fields such as:

• cname: Channel name.
• uid: Recording user ID.
• sid: Recording ID.
• sequence: Notification sequence number.
• sendts: Event timestamp in Unix milliseconds.
• serviceType: Agora service type.
• details: Event-specific details.

Signature verification

Always verify callback signatures before you trust the payload. For webhook setup and validation guidance, see Receive notifications.

Common callback categories

Cloud Recording callbacks cover the following event groups:

• Recording errors and warnings
• Recording status changes
• Recorder lifecycle events
• Upload lifecycle events
• Web page recording events

For the Cloud Recording event fields and examples, see the workflow guide:

• Receive notifications

Related references

• Cloud Recording RESTful API
• Authenticate REST calls
• Common errors