Skip to main content

How do they work?

Get to know how you can start using the listener feature

So, you’ve heard about the Listener feature and you’re curious how it works.

At its core, the Listener feature revolves around Q-Flow Sources. Let’s dive in and walk through the first step: creating a Source.

Creating a Source​

To set up a Q-Flow Source:

Create a source

  1. Open the Management Portal.
  2. Select Sources in the left sidebar menu.
  3. Press the Add new Source button.
  4. Give the Source a unique name (unique across both Topics and Sources).
  5. Add a brief description for the Source.
  6. Select the HTTP Method for Source URL.
  7. Click Create.`

Listening Sources Page

That’s it! 🎉 You’ve created your first Source and are ready to start listening for events.

You can verify it by returning to the Sources listing page, where your new Source will appear.

Sources Details Page

Additionally, a unique URL will be automatically generated for you. This URL allows external/internal services to interact with your Source.

Just click the copy button to use it!

You can also find this URL on the Source’s details page, along with additional information.

warning

The generated URL is unique and cannot be changed. Please make sure to keep it secure!

Update a Source​

Need to update a Source? Follow these steps:

Sources Update Page

  1. Open the Management Portal.
  2. Select Sources in the left sidebar menu.
  3. Locate the Source you want to update:
    • Either click on the Source and press the cog icon to edit.
    • Or, use the pencil icon from the Sources listing page.
  4. Make the necessary changes.
  5. Click Update.

Your changes will take effect immediately, and you can review them on the Source’s details page.

Delete a Source​

If you no longer need a Source, you can delete it by:

Sources Delete Modal Confirmation

  1. Open the Management Portal.
  2. Select Sources in the left sidebar menu.
  3. Finding the Source you want to delete and clicking the delete button.
  4. Confirm the deletion.
danger

Deleting a Source is permanent and cannot be undone. Ensure you no longer need the Source before proceeding.

This action can have a significant impact on any systems subscribed to the Source.

And there you have it! You’ve learned how to create, update, and delete a Source.

But we’ve only scratched the surface—there are more configuration options available to fine-tune your Source. Choose from the options below to learn more, or jump right in and start creating subscriptions.

HTTP Methods​

The HTTP Method you select for your Source URL determines how external entities will interact with your newly created Source.

Either GET, POST, PUT, or DELETE can be selected. It's a required field that cannot be left blank.

But we got you covered! If no method is selected, a warning will appear, prompting you to select one. Promp Warning Message No HTTP Method Selected

warning

If the client sends a request with an unsupported method, a 405 Method Not Allowed error will be returned.