Skip to main content
PUT
/
v2
/
endpoint
/
{endpoint_id}
Update Webhook Endpoint
curl --request PUT \
  --url https://api.jogg.ai/v2/endpoint/{endpoint_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://your-domain.com/webhook",
  "status": "enabled",
  "events": [
    "generated_avatar_video_success",
    "generated_avatar_video_failed",
    "generated_photo_avatar_success"
  ]
}
'
{
  "code": 0,
  "msg": "Success",
  "data": {
    "endpoint_id": "wh_123456789",
    "url": "https://your-domain.com/webhook",
    "secret": "whsec_abc123xyz",
    "status": "enabled",
    "events": [
      "generated_avatar_video_success",
      "generated_avatar_video_failed"
    ],
    "username": "johndoe",
    "created_at": 1732806631
  }
}
Update an existing webhook endpoint configuration, including URL, status, and subscribed events.

​
Use Cases

  • Modify webhook receiver URL
  • Update subscribed event types
  • Enable or disable webhook
  • Adjust event notification scope

​
Status Management

Set status to disabled to temporarily stop receiving events without deleting the endpoint configuration.

​
Important Notes

After updating the webhook endpoint, the new configuration takes effect immediately. Ensure the new URL is ready to receive requests.

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
endpoint_id
string
required

Unique webhook endpoint identifier

Example:

"wh_123456"

Body

application/json
​
url
string<uri>
required

Updated webhook endpoint URL

Example:

"https://your-domain.com/webhook"

​
status
enum<string>
required

Webhook status

Available options:
enabled,
disabled
Example:

"enabled"

​
events
string[]
required

Updated list of event types

Example:
[
  "generated_avatar_video_success",
  "generated_avatar_video_failed",
  "generated_photo_avatar_success"
]

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