Skip to main content
POST
/
endpoint
Add webhook endpoint
curl --request POST \
  --url https://api.jogg.ai/v1/endpoint \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com/webhook",
  "events": [
    "generated_video_success"
  ],
  "status": "enabled"
}
'
{
  "endpoint_id": "b1ac30a401234c96ad128303dfb431e2",
  "url": "https://example.com/webhook",
  "secret": "your-secret-key",
  "status": "enabled",
  "events": [
    "generated_video_success"
  ],
  "username": "[email protected]",
  "created_at": 1703894400
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string
required

Webhook endpoint URL (must be HTTPS)

Example:

"https://example.com/webhook"

​
events
enum<string>[]
required

List of events to subscribe to

Available options:
generated_video_success,
generated_video_failed
Example:
["generated_video_success"]
​
status
enum<string>
default:enabled

Webhook status

Available options:
enabled,
disabled
Example:

"enabled"

Response

200 - application/json

Successful operation

​
endpoint_id
string

Unique identifier for the webhook

Example:

"b1ac30a401234c96ad128303dfb431e2"

​
url
string

Webhook URL

Example:

"https://example.com/webhook"

​
secret
string

Secret for signature verification

Example:

"your-secret-key"

​
status
string

Current webhook status

Example:

"enabled"

​
events
string[]

List of subscribed events

Example:
["generated_video_success"]
​
username
string

Username

Example:

"[email protected]"

​
created_at
integer

Creation timestamp (Unix timestamp)

Example:

1703894400