Romulus icon

Romulus

Consume Romulus API

Webhook → Create

AI-generated

Overview

This node creates a webhook for the Romulus API, allowing users to set up event-driven notifications. It is useful for scenarios where you want to receive real-time updates about specific events, such as when an agent call or action is completed. For example, you can create a webhook to notify your system whenever an agent call is completed, enabling automated workflows or alerts.

Use Case Examples

  1. Create a webhook to notify your application when an agent call is completed.
  2. Set up a webhook to trigger actions when an agent action is completed.

Properties

Name Meaning
Event The type of event that triggers the webhook. Options include 'Agent Call Completed' and 'Agent Action Completed'.
URL The HTTPS URL to which webhook notifications will be sent. Must be a valid URL.
Additional Fields Optional additional settings for the webhook, including retry attempts, retry interval, associated entity ID and type, and extra specifications in JSON format.

Output

JSON

  • webhookId - The unique identifier of the created webhook.
  • event - The event type that triggers the webhook.
  • url - The URL to which webhook notifications are sent.
  • attempts - Number of retry attempts configured for the webhook.
  • attempts_interval_seconds - Interval in seconds between retry attempts.
  • entity_id - ID of the associated entity.
  • entity_type - Type of the associated entity.
  • specifications - Additional JSON specifications for the webhook.

Dependencies

  • Requires access to the Romulus API with appropriate authentication credentials.

Troubleshooting

  • Ensure the URL is a valid HTTPS URL; otherwise, the webhook creation will fail with a validation error.
  • If the webhook creation fails, check that the event type is supported and correctly specified.
  • Verify that the API credentials used have permissions to create webhooks in the Romulus system.
  • If retry attempts or intervals are set incorrectly (e.g., negative numbers), the node may throw an error.

Discussion