JoggAI icon

JoggAI

Interact with the JoggAI API to create and manage AI videos

Webhook → Add a Webhook Endpoint

AI-generated

Overview

This node operation allows users to add a webhook endpoint to the JoggAI platform. It is useful for subscribing to specific events such as video generation success or failure, and avatar creation success or failure. Users provide a secure HTTPS URL where event notifications will be sent, enabling automated workflows triggered by these events.

Use Case Examples

  1. A user wants to receive notifications when a video is successfully generated by JoggAI. They add a webhook endpoint URL and subscribe to the 'Generated Video Success' event.
  2. A user wants to monitor avatar creation failures. They add a webhook endpoint and subscribe to the 'Create Avatar Failed' event to get alerts and handle errors automatically.

Properties

Name Meaning
URL The HTTPS URL of the webhook endpoint where event notifications will be sent.
Events The list of events to subscribe to for receiving notifications via the webhook.
Status The status of the webhook, indicating whether it is enabled or disabled.

Output

JSON

  • id - Unique identifier of the created webhook.
  • url - The webhook endpoint URL.
  • events - List of events the webhook is subscribed to.
  • status - Current status of the webhook (enabled or disabled).
  • createdAt - Timestamp when the webhook was created.

Dependencies

  • JoggAI API with an API key credential

Troubleshooting

  • Ensure the webhook URL is HTTPS as required; non-HTTPS URLs will be rejected.
  • Verify that the events selected are valid and supported by the JoggAI platform.
  • If the webhook status is set to disabled, no events will be sent to the endpoint.
  • Common errors include invalid URL format, missing required parameters, or API authentication failures. Check the error message for details and verify credentials and input values.

Links

Discussion