Overview

This node operation creates a webhook subscription for the Romulus API. It allows users to specify a URL to receive webhook notifications, the type of entity for the subscription, and optionally an entity ID to subscribe to specific entities. This is useful for integrating external systems to receive real-time updates or events from Romulus related to calls.

Use Case Examples

1. A user wants to receive notifications about robocall events in their system. They configure the node with the webhook URL and entity type 'ROBOCALL' to get updates whenever such events occur.
2. An application needs to monitor specific call entities for changes. The user sets the webhook URL, entity type, and provides an entity ID to subscribe to updates for that particular entity.

Properties

Output

JSON

• webhookSubscriptionId - The unique identifier of the created webhook subscription.
• status - The status of the webhook subscription creation request.
• message - Any message returned from the API regarding the subscription creation.

Dependencies

• Romulus API
• An API key credential for authentication

Troubleshooting

• Ensure the URL is a valid HTTPS URL as required by the pattern validation; otherwise, the node will throw a validation error.
• If the entity type is incorrect or unsupported, the API may return an error indicating invalid entity type.
• Missing or incorrect API credentials will result in authentication errors when attempting to create the webhook subscription.

Links

• Romulus API Webhooks Documentation - Official documentation for creating and managing webhook subscriptions in Romulus API.