Romulus icon

Romulus

Consume Romulus API

Call → List Webhook Subscriptions

AI-generated

Overview

The 'Call' resource with the 'List Webhook Subscriptions' operation is designed to retrieve a list of existing webhook subscriptions from the Romulus API. This functionality is particularly useful for monitoring and managing active webhooks, allowing users to view all current webhook subscriptions associated with their account.

Use Case Examples

  1. A user wants to audit all active webhook subscriptions to ensure they are correctly configured.
  2. A developer needs to retrieve a list of webhook subscriptions to update or remove specific ones.

Properties

Name Meaning
Return All Determines whether to fetch all webhook subscriptions or limit the number of results returned. When set to true, all subscriptions are retrieved; when false, only a subset is returned.

Output

JSON

  • webhookSubscriptions - An array containing details of each webhook subscription, such as subscription ID, event type, and associated endpoint.

Troubleshooting

  • Ensure that the Romulus API is accessible and that the necessary authentication credentials are correctly configured.
  • Verify that the 'Return All' property is set according to your data retrieval needs, as setting it to false may limit the number of subscriptions returned.

Discussion