JoggAI icon

JoggAI

Interact with the JoggAI API to create and manage AI videos

Webhook → Update a Webhook Endpoint

AI-generated

Overview

This node operation updates an existing webhook endpoint in the JoggAI system. It allows users to modify the webhook's URL, the list of subscribed events, and the webhook's status (enabled or disabled). This is useful for managing webhook endpoints dynamically, such as changing the destination URL for webhook notifications or updating the events that trigger the webhook.

Use Case Examples

  1. Updating a webhook endpoint URL to a new HTTPS address.
  2. Changing the events a webhook subscribes to, for example, switching from 'Generated Video Success' to 'Create Avatar Success'.
  3. Enabling or disabling a webhook endpoint based on application needs.

Properties

Name Meaning
Endpoint ID The unique identifier of the webhook endpoint to update.
URL The new HTTPS URL to which the webhook will send events.
Events The new list of events that the webhook will subscribe to, such as video generation success or avatar creation failure.
Status The new status of the webhook endpoint, either enabled or disabled.

Output

JSON

  • id - The unique identifier of the updated webhook endpoint.
  • url - The updated URL of the webhook endpoint.
  • events - The list of events the webhook endpoint is subscribed to after the update.
  • status - The current status of the webhook endpoint after the update.

Dependencies

  • JoggAI API key credential for authentication

Troubleshooting

  • Common issues include providing an invalid or non-HTTPS URL, which will cause the update to fail.
  • If the endpoint ID is incorrect or does not exist, the node will throw an error indicating the webhook endpoint was not found.
  • Errors related to authentication usually mean the API key credential is missing or invalid.
  • Ensure the events list is not empty; otherwise, the webhook may not function as expected.

Discussion