Notification Channels

Notification Channels allow you to define where alerts and important updates from PyQueryHub should be sent. This helps you and your team stay informed by receiving notifications directly in the communication tools you use every day.

All configured channels are available workspace-wide.

1. Supported Channel Types

You can configure notifications to be sent to the following types of channels:

  • Email: Receive notifications at a specified email address.
  • Slack: Get updates directly in a Slack channel via an Incoming Webhook.
  • WhatsApp: Receive messages on a WhatsApp number.
  • Telegram: Get notifications in a Telegram chat or channel.

2. Managing Your Notification Channels

You can manage your workspace's notification channels by navigating to the "Notification Channels" page (you might find this under a "Settings," "Alerts," or "Integrations" section in PyQueryHub).

On this page, you will see:

  • A list of all channels already configured for your workspace, showing their Alias, Type, and Target.
  • An "Add Channel" button to create new channels.
  • "Edit" and "Delete" options for each existing channel.

If no channels have been set up yet, you'll see a message indicating this.

3. Adding a New Channel

To add a new notification channel:

  1. Click the "Add Channel" button. A "Create New Channel" dialog will appear.

  2. Fill in the following details:

    • Alias:
      • Enter a friendly, descriptive name for this channel. This name is for your reference to easily identify it later (e.g., "Critical Support Alerts Email," "Dev Team Slack Updates," "Sales WhatsApp Group").
    • Type:
      • Select the type of channel you want to add from the dropdown list (Email, Slack, WhatsApp, or Telegram).
    • Target:
      • The information required for the "Target" field depends on the "Type" you selected. Here’s what to enter for each type:
        • Email:
          • Target: The email address where notifications should be sent.
          • Example: support@example.com
        • Slack:
          • Target: Your Slack Incoming Webhook URL. You can generate this URL from your Slack app's settings.
          • Example: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
        • WhatsApp:
          • Target: The international phone number (in E.164 format) that should receive the WhatsApp messages. This must include the country code, preceded by a +.
          • Example: +14155552671
        • Telegram:
          • Target: The numeric chat_id for a Telegram group or private chat, or the @username for a public channel or user.
          • Example (Chat ID): -1001234567890
          • Example (Username): @my_notification_channel

  3. Once you have filled in all the details, click the "Create Channel" button.

Important Subscription Note: Creating and using notification channels requires an active subscription to one of our paid plans. If you do not have an active subscription, you may see an error message prompting you to subscribe.

4. Editing an Existing Channel

If you need to update the details of an existing channel (e.g., change the target email address or update a Slack webhook URL):

  1. On the "Notification Channels" page, find the channel you wish to modify in the list.
  2. Click the "Edit" button next to it.
  3. The "Edit Channel" dialog will appear, pre-filled with the channel's current information.
  4. Make your necessary changes to the Alias, Type, or Target.
  5. Click the "Update Channel" button to save your changes.

5. Deleting a Channel

If a notification channel is no longer needed:

  1. On the "Notification Channels" page, locate the channel you want to remove.
  2. Click the "Delete" button next to it.
  3. A confirmation dialog will appear asking, "Are you sure you want to delete this channel? This action cannot be undone."
  4. If you are sure, click the "Delete Channel" button in the confirmation dialog. The channel will be permanently removed.

6. How Channels Are Used

Once configured, these notification channels can be selected when you set up alerts or automated notifications in other parts of PyQueryHub. For example, when creating an alert for a report, you might be able to choose one or more of these channels to receive a notification if the alert condition is met.

Troubleshooting Tips:

  • Always double-check the "Target" information for accuracy (e.g., correct email spelling, valid webhook URL, correct phone number format, valid chat ID).
  • For services like Slack or Telegram, ensure that any necessary permissions have been granted (e.g., if it's a bot, ensure it has been added to the relevant Slack channel or Telegram chat and has permission to post).

If you encounter any issues setting up or managing your notification channels, please contact our support team for assistance.