Skip to main content
GET
/
v2
/
events
List Webhook Events
curl --request GET \
  --url https://api.jogg.ai/v2/events \
  --header 'x-api-key: <api-key>'
{
  "code": 0,
  "msg": "Success",
  "data": {
    "events": [
      "generated_video_success",
      "generated_video_failed",
      "create_avatar_success",
      "create_avatar_failed",
      "generated_product_video_success",
      "generated_product_video_failed",
      "generated_avatar_video_success",
      "generated_avatar_video_failed",
      "generated_template_video_success",
      "generated_template_video_failed",
      "generated_translate_video_success",
      "generated_translate_video_failed",
      "generated_photo_avatar_success",
      "generated_photo_avatar_failed",
      "generated_product_avatar_success",
      "generated_product_avatar_failed",
      "generated_script_success",
      "generated_script_failed"
    ]
  }
}
Get a list of all available webhook event types that you can subscribe to. Each event type represents a specific action or status change in the system.

​
Use Cases

  • View all available event types
  • Select events to subscribe to
  • Understand event naming conventions

​
Response Example

{
  "rid": "",
  "code": 0,
  "msg": "success",
  "data": {
    "events": [
      "generated_video_success",
      "generated_video_failed",
      "create_avatar_success",
      "create_avatar_failed",
      "generated_image_success",
      "generated_image_failed",
      "generated_motion_success",
      "generated_motion_failed",
      "generated_product_video_success",
      "generated_product_video_failed",
      "generated_avatar_video_success",
      "generated_avatar_video_failed",
      "generated_template_video_success",
      "generated_template_video_failed",
      "generated_translate_video_success",
      "generated_translate_video_failed",
      "generated_photo_avatar_success",
      "generated_photo_avatar_failed",
      "generated_product_avatar_success",
      "generated_product_avatar_failed",
      "generated_script_success",
      "generated_script_failed"
    ]
  }
}

​
Available Event Types

​
Video Generation Events

Event TypeDescription
generated_video_successVideo generation succeeded
generated_video_failedVideo generation failed
generated_product_video_successProduct video generation succeeded
generated_product_video_failedProduct video generation failed
generated_avatar_video_successAvatar video generation succeeded
generated_avatar_video_failedAvatar video generation failed
generated_template_video_successTemplate video generation succeeded
generated_template_video_failedTemplate video generation failed
generated_translate_video_successVideo translation succeeded
generated_translate_video_failedVideo translation failed

​
Avatar Generation Events

Event TypeDescription
create_avatar_successAvatar creation succeeded
create_avatar_failedAvatar creation failed
generated_photo_avatar_successPhoto avatar creation succeeded
generated_photo_avatar_failedPhoto avatar creation failed
generated_product_avatar_successProduct avatar creation succeeded
generated_product_avatar_failedProduct avatar creation failed

​
AI Script Generation Events

Event TypeDescription
generated_script_successAI script generation succeeded
generated_script_failedAI script generation failed

​
Image Generation Events

Event TypeDescription
generated_image_successImage generation succeeded
generated_image_failedImage generation failed

​
Motion Generation Events

Event TypeDescription
generated_motion_successMotion generation succeeded
generated_motion_failedMotion generation failed
We recommend subscribing to at least *_success and *_failed events to stay informed about task completion status.

​
Webhook Payload Examples

When an event is triggered, your endpoint will receive a JSON payload similar to the following:

​
Video Generation Success Event

{
  "event_id": "evt_123456789",
  "event": "generated_avatar_video_success",
  "timestamp": 1732806631,
  "data": {
    "video_id": "video_123456",
    "status": "completed",
    "video_url": "https://res.jogg.ai/video.mp4",
    "cover_url": "https://res.jogg.ai/cover.jpg",
    "duration": 30
  }
}

​
Avatar Generation Success Event

{
  "event_id": "evt_987654321",
  "event": "generated_photo_avatar_success",
  "timestamp": 1732806631,
  "data": {
    "avatar_id": 12345,
    "status": "completed",
    "preview_url": "https://res.jogg.ai/avatar-preview.mp4"
  }
}

​
Script Generation Success Event

{
  "event": "generated_script_success",
  "timestamp": 1732806631,
  "data": {
    "task_id": "task_123456",
    "status": "completed",
    "scripts": [
      {
        "script_style": "Storytime",
        "script_paragraphs": "Your generated script content..."
      }
    ]
  }
}

​
Image Generation Success Event

{
  "event": "generated_image_success",
  "timestamp": 1732806631,
  "data": {
    "photo_id": "photo_123456",
    "photo_urls": [
      "https://res.jogg.ai/image1.jpg",
      "https://res.jogg.ai/image2.jpg"
    ]
  }
}

​
Image Generation Failed Event

{
  "event": "generated_image_failed",
  "timestamp": 1732806631,
  "data": {
    "photo_id": "photo_123456",
    "error": "Image generation failed due to invalid parameters"
  }
}

​
Motion Generation Success Event

{
  "event": "generated_motion_success",
  "timestamp": 1732806631,
  "data": {
    "motion_id": "motion_123456",
    "motion_url": "https://res.jogg.ai/motion.mp4",
    "photo_url": "https://res.jogg.ai/photo.jpg"
  }
}

​
Motion Generation Failed Event

{
  "event": "generated_motion_failed",
  "timestamp": 1732806631,
  "data": {
    "motion_id": "motion_123456",
    "error": "Motion generation failed due to processing error"
  }
}

​
Best Practices

  • Use idempotent processing: The same event may be sent multiple times, ensure your logic handles this
  • Implement retry logic: The system will retry sending webhooks if processing fails
  • Respond quickly: Return a 2xx status code within 5 seconds to avoid timeouts
  • Process asynchronously: Return 200 immediately after receiving the event, then process business logic asynchronously
  • Verify signatures: Use the webhook secret to verify request authenticity

​
Event Naming Convention

Most events follow the generated_{resource}_{status} or create_{resource}_{status} naming pattern:
  • {resource}: Resource type (e.g., avatar_video, product_avatar, script, avatar)
  • {status}: Status (success or failed)
Note: Some legacy events use simpler naming (e.g., generated_video_success, create_avatar_success).

Authorizations

​
x-api-key
string
header
required

API key for authentication. Obtain your key from the JoggAI dashboard.

Response

200 - application/json

Success

​
code
integer
required

Business status code:

  • 0 - Success
  • 10104 - Record not found
  • 10105 - Invalid API key
  • 18020 - Insufficient credit
  • 18025 - No permission to call APIs
  • 40000 - Parameter error
  • 50000 - System error
Example:

0

​
msg
string
required

Response message

Example:

"Success"

​
data
object