Notification Setup

Unstract provides notification capabilities that allow you to monitor the status of your APIs, ETL Pipelines, and Task Pipelines. When configured, notifications will be sent to your specified webhook endpoints upon completion of executions.

Setting Up Notifications

Step 1: Access Notification Settings

1. Navigate to the desired section (API Deployments, ETL Pipelines, or Task Pipelines)
2. Locate the pipeline or API you want to configure notifications for
3. Click the "Actions" menu (...) on the right side of the item
4. Select "Setup Notification" from the dropdown menu

Step 2: Create a New Notification

1. In the notification setup page, click the "Create Notification" button

Step 3: Configure Notification Settings

1. Fill out the notification configuration form:

   • Name: Give your notification a clear, descriptive name (e.g., "Slack-API-Status")
   • URL: Enter your webhook URL where notifications will be sent (e.g., Slack webhook URL).
   • Notification Type: Select WEBHOOK (default option).
   • Platform: Choose your notification platform
     • SLACK: For Slack workspace notifications
     • API: For custom API endpoints
   • Authorization Type: Select the required authentication method.
     • BEARER: For Bearer token authentication
     • API_KEY: For Api key header
     • CUSTOM_HEADER: For custom API key in header
     • NONE: For webhooks without authentication
   • Max Retries: Set the number of retry attempts (maximum 4) in case of delivery failure.

2. Click "Create Notification" to save your configuration

Note: Make sure your webhook URL is active and properly configured in your chosen platform (Slack, Webhook API, etc.) before proceeding.

Step 4: Activate the Notification

1. After creating the notification, toggle the "Active" switch to enable it
2. The notification is now ready to send updates to your webhook endpoint