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"
}
'
import requests

url = "https://api.jogg.ai/v1/endpoint"

payload = {
"url": "https://example.com/webhook",
"events": ["generated_video_success"],
"status": "enabled"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://example.com/webhook',
events: ['generated_video_success'],
status: 'enabled'
})
};

fetch('https://api.jogg.ai/v1/endpoint', 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/v1/endpoint",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://example.com/webhook',
'events' => [
'generated_video_success'
],
'status' => 'enabled'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.jogg.ai/v1/endpoint"

payload := strings.NewReader("{\n \"url\": \"https://example.com/webhook\",\n \"events\": [\n \"generated_video_success\"\n ],\n \"status\": \"enabled\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.jogg.ai/v1/endpoint")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhook\",\n \"events\": [\n \"generated_video_success\"\n ],\n \"status\": \"enabled\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v1/endpoint")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com/webhook\",\n \"events\": [\n \"generated_video_success\"\n ],\n \"status\": \"enabled\"\n}"

response = http.request(request)
puts response.read_body
{
  "endpoint_id": "b1ac30a401234c96ad128303dfb431e2",
  "url": "https://example.com/webhook",
  "secret": "your-secret-key",
  "status": "enabled",
  "events": [
    "generated_video_success"
  ],
  "username": "jogg@gmail.com",
  "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:

"jogg@gmail.com"

created_at
integer

Creation timestamp (Unix timestamp)

Example:

1703894400