Hello, Is it possible to register some webhook or ...
# ask-community-for-troubleshooting
l
Hello, Is it possible to register some webhook or some means of sending notifications via HTTP to an API application when the status of a connection is updated?
k
A message from kapa.ai
Yes, it is possible to set up Airbyte to send notifications when the status of a connection is updated. You can configure Airbyte to notify you when syncs have failed or succeeded using a webhook, a URL that you can input into other applications to get real-time data from Airbyte. Here's how to set up Slack notifications as an example: 1. Set up the bot by navigating to https://api.slack.com/apps/ and clicking
Create an App
. Then click
From scratch
, enter your App Name, and pick your desired Slack workspace. 2. Set up the webhook URL by clicking on
Incoming Webhooks
in the left sidebar. Turn on the feature, click
Add New Webhook to Workspace
, and pick the channel you want to receive Airbyte notifications in. 3. Copy the active webhook URL. 4. Add the webhook to Airbyte by navigating to the UI, clicking on Settings, and then clicking on
Notifications
. Paste the copied webhook URL in
Connection status Webhook URL
. You can find more detailed instructions in the [Configuring Sync Notifications](https://docs.airbyte.com/operator-guides/configuring-sync-notifications) guide. However, it's important to note that Airbyte currently supports only one webhook for a given workspace. If you need to send notifications to multiple destinations, you might need to create a custom solution, such as a microservice that uses the Airbyte API to check the status of specific jobs and sends notifications accordingly. Source: [Configuring Sync Notifications](https://docs.airbyte.com/operator-guides/configuring-sync-notifications)
l
@kapa.ai Is it possible to register some URL of my application to receive notification when a connection is updated? (like for example: http://localhost:300/airbyte/notification)
k
A message from kapa.ai
Yes, it is possible to register a custom URL to receive notifications when a connection is updated. Airbyte supports webhook notifications, which can be set up to send notifications to any endpoint, including your application's URL. To set up a webhook for your custom URL, follow these steps: 1. Set up the webhook URL in your application to receive notifications. 2. In your Airbyte instance, navigate to the UI, click on Settings, and then click on
Notifications
. 3. Paste your custom webhook URL (e.g., `http://localhost:300/airbyte/notification`) in the
Connection status Webhook URL
field. 4. Choose whether you want notifications on sync successes, failures, or both by clicking the appropriate sliders. 5. Click
Save changes
. For more information on setting up webhook notifications, refer to the [Airbyte documentation](https://docs.airbyte.com/operator-guides/configuring-sync-notifications). Keep in mind that the webhook URL should be accessible by your Airbyte instance. If you're using
localhost
, make sure your Airbyte instance and your application are running on the same machine. Otherwise, use a publicly accessible URL for your application.
l
@kapa.ai I did what you said, but when I put my application's URL in the field, it gives me this error: field must be a valid URL
k
A message from kapa.ai
It seems like the URL you entered might not be in the correct format. Make sure that the URL you provide is a valid and properly formatted URL. For example, if you're using
localhost
, ensure that you include the protocol (
http://
or
https://
) and the correct port number. The correct format should look like this:
<http://localhost:3000/airbyte/notification>
. If you're still facing issues, please double-check the URL format and ensure that your application is running and accessible at the provided URL. If the problem persists, consider looking into the Airbyte logs for more information or reaching out to the Airbyte community on [Slack](https://airbytehq.slack.com) or the [forum](https://discuss.airbyte.io) for further assistance.