List Webhook Events

curl --request GET \
  --url https://api.jogg.ai/v2/events \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jogg.ai/v2/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jogg.ai/v2/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jogg.ai/v2/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v2/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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

events

List Webhook Events

curl --request GET \
  --url https://api.jogg.ai/v2/events \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jogg.ai/v2/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jogg.ai/v2/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jogg.ai/v2/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v2/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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 Type	Description
`generated_video_success`	Video generation succeeded
`generated_video_failed`	Video generation failed
`generated_product_video_success`	Product video generation succeeded
`generated_product_video_failed`	Product video generation failed
`generated_avatar_video_success`	Avatar video generation succeeded
`generated_avatar_video_failed`	Avatar video generation failed
`generated_template_video_success`	Template video generation succeeded
`generated_template_video_failed`	Template video generation failed
`generated_translate_video_success`	Video translation succeeded
`generated_translate_video_failed`	Video translation failed

Avatar Generation Events

Event Type	Description
`create_avatar_success`	Avatar creation succeeded
`create_avatar_failed`	Avatar creation failed
`generated_photo_avatar_success`	Photo avatar creation succeeded
`generated_photo_avatar_failed`	Photo avatar creation failed
`generated_product_avatar_success`	Product avatar creation succeeded
`generated_product_avatar_failed`	Product avatar creation failed

AI Script Generation Events

Event Type	Description
`generated_script_success`	AI script generation succeeded
`generated_script_failed`	AI script generation failed

Image Generation Events

Event Type	Description
`generated_image_success`	Image generation succeeded
`generated_image_failed`	Image generation failed

Motion Generation Events

Event Type	Description
`generated_motion_success`	Motion generation succeeded
`generated_motion_failed`	Motion 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

Show child attributes

QuickStart

Workflows Guides

Video

Avatar

Voice

Asset

Template

Product

User

Webhook

List Webhook Events

Use Cases

Response Example

Available Event Types

Video Generation Events

Avatar Generation Events

AI Script Generation Events

Image Generation Events

Motion Generation Events

Webhook Payload Examples

Video Generation Success Event

Avatar Generation Success Event

Script Generation Success Event

Image Generation Success Event

Image Generation Failed Event

Motion Generation Success Event

Motion Generation Failed Event

Best Practices

Event Naming Convention

Authorizations

Response

​Use Cases

​Response Example

​Available Event Types

​Video Generation Events

​Avatar Generation Events

​AI Script Generation Events

​Image Generation Events

​Motion Generation Events

​Webhook Payload Examples

​Video Generation Success Event

​Avatar Generation Success Event

​Script Generation Success Event

​Image Generation Success Event

​Image Generation Failed Event

​Motion Generation Success Event

​Motion Generation Failed Event

​Best Practices

​Event Naming Convention

Authorizations

Response

Use Cases

Response Example

Available Event Types

Video Generation Events

Avatar Generation Events

AI Script Generation Events

Image Generation Events

Motion Generation Events

Webhook Payload Examples

Video Generation Success Event

Avatar Generation Success Event

Script Generation Success Event

Image Generation Success Event

Image Generation Failed Event

Motion Generation Success Event

Motion Generation Failed Event

Best Practices

Event Naming Convention